Get a message

Returns a message by its ID: addresses, subject, status, and why it is waiting when it is. Per-recipient delivery state and the body are their own reads.

GET
/v1/messages/{id}

Returns a message by its ID: addresses, subject, status, and why it is waiting when it is. Per-recipient delivery state and the body are their own reads.

x-api-key<token>

In: header

Path Parameters

id*string
Match^msg_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/messages/string"
{  "id": "string",  "channel": "email",  "direction": "outbound",  "status": "pending",  "from": {    "address": "string",    "name": "string"  },  "to": [    {      "address": "string",      "contactId": "string"    }  ],  "cc": [    {      "address": "string",      "contactId": "string"    }  ],  "bcc": [    {      "address": "string",      "contactId": "string"    }  ],  "replyTo": [    "string"  ],  "subject": "string",  "conversationId": "string",  "inReplyToMessageId": "string",  "tags": [    "string"  ],  "metadata": {    "property1": "string",    "property2": "string"  },  "isTest": true,  "scheduledAt": "string",  "submission": {    "origin": "direct",    "transport": "http",    "credential": {      "kind": "api_key",      "apiKeyId": "string"    },    "userId": "string",    "client": {      "surface": "typescript-promise",      "version": "string"    }  },  "waitReason": "rate",  "reviewExpectedAt": "string",  "skippedRecipients": [    {      "address": "string",      "reason": "bounce",      "unsubscribeGroupId": "string"    }  ],  "createdAt": "string",  "updatedAt": "string"}

Related documentation