v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
messages

Update delivery status of message recipients.

Request body should be a dict mapping MessageRecipient IDs to target statuses. Example: {"recipient_id_1": "cancelled", "recipient_id_2": "retry"}

Allowed transitions:

  • FAILED -> CANCELLED
  • FAILED -> RETRY manual retry, only for messages sent within the configured max age: MESSAGES_MANUAL_RETRY_MAX_AGE
  • RETRY -> CANCELLED
patch/api/v1.0/messages/{id}/delivery-statuses/

Path parameters

idstring uuid required

primary key for the record as UUID

Response

updated_countinteger required