Skip to main content
POST
email.messages.batch.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 whose messages to update.

Required string length: 1 - 320
messageIds
string[]
required

The messages' public RFC Message-IDs, at most 50 per call, e.g. abc@example.com. Repeated ids are counted once.

Required array length: 1 - 50 elements
Required string length: 1 - 998
addLabels
string[]

Labels to add to every 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 from every message. Removal wins over adding.

Maximum array length: 20

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

Required string length: 1 - 64

Response

The result

results
object[]
required

One row per updated message.

skipped
string[]
required

Requested ids that were not updated, e.g. unknown messages.