Skip to main content
POST
email.message.attributes.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
ref
string
required

The ref returned by email.message.send.

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

Mailbox owning the message.

Required string length: 1 - 320
starred
boolean

Set or clear the star.

unread
boolean

Set or clear unread status.

metadata
object

Up to 50 metadata pairs; replaces existing metadata.

Response

The result

starred
boolean
required

Current star state.

unread
boolean
required

Current unread state.

metadata
object
required

Current metadata.