Skip to main content
POST
email.message.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string
required

The inbox address the message belongs to.

Required string length: 1 - 320
ref
string

The ref a send, reply or draft-send returned. Preferred over messageId.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
messageId
string

The message's public RFC Message-ID, e.g. abc@example.com.

Required string length: 1 - 998
addLabels
string[]

Labels to add to the message.

Maximum array length: 20

A label, up to 64 characters, e.g. awaiting-reply.

Required string length: 1 - 64
removeLabels
string[]

Labels to remove. Removing wins over adding the same label.

Maximum array length: 20

A label, up to 64 characters, e.g. awaiting-reply.

Required string length: 1 - 64

Response

The result

messageId
string
required

The message's public RFC Message-ID, e.g. abc@example.com.

labels
string[]
required

The labels on the message after the change.