Skip to main content
id
string
Example: message_123Match pattern: message_\d+
object
string
The resource in the response. Always message.Allowed value: message
created_at
string<date-time>
ISO 8601 date-time string.Example: 2023-01-01T10:00+00:00
updated_at
string<date-time>
ISO 8601 date-time string.Example: 2023-01-01T10:00+00:00
provider
string
The v1 API ID of a Provider. Will be updated in future versions.Example: provider_123Match pattern: provider_\d+
transactional
boolean
Whether this message should respect or ignore the suppression status of recipients.
contents
object

Example

{
  "id": "message_123",
  "object": "message",
  "created_at": "2023-01-01T10:00+00:00",
  "updated_at": "2023-01-01T10:00+00:00",
  "provider": "provider_123",
  "transactional": false,
  "contents": {
    "object": "list",
    "data": [
      {
        "type": "email",
        "email": {
          "id": "contents_123",
          "subject": "Welcome to our newsletter",
          "body": "<html>...</html>",
          "from": "email_address_123",
          "to": "email_address_456"
        }
      }
    ]
  }
}