Messages

POST /v1/messages:batch-send

One sender to up to 500 people; one result per recipient

• Scope: messages:write
• Idempotency: send Idempotency-Key; a retry with the same key returns the first result.

Parameter	In	Type	Required	Description
Idempotency-Key	header	string		Retries with the same key return the first result for 24 hours

Request body

Field	Type	Required	Description
as	string	yes	A user id, or “system”
to	string[]	yes
text	string	yes
kind	string
payload	object
client_msg_id	string

200 OK

Field	Type	Required	Description
results	ItemResult[]

Errors are problem documents with a code.

PATCH /v1/messages/{id}

Edit

• Scope: messages:write

Parameter	In	Type	Required	Description
id	path	string	yes	Message id

Request body

Field	Type	Required	Description
as	string	yes	A user id, or “system”
text	string	yes
payload	object

200 OK

Field	Type	Required	Description
seq	integer

Errors are problem documents with a code.

POST /v1/messages/{id}:recall

Recall (the system recalls any message)

• Scope: messages:write
• Idempotency: send Idempotency-Key; a retry with the same key returns the first result.

Parameter	In	Type	Required	Description
id	path	string	yes	Message id
Idempotency-Key	header	string		Retries with the same key return the first result for 24 hours

Request body

Field	Type	Required	Description
as	string		A user id, or “system”

200 OK

Field	Type	Required	Description
seq	integer

Errors are problem documents with a code.