Skip to main content
Retrieve a Message
curl --request GET \
  --url https://api.example.com/api/v4/messages/{id} \
  --header ':cookie: <api-key>' \
  --header 'X-Vero-Project-Id: <x-vero-project-id>'
{
  "id": "message_123",
  "object": "message",
  "created_at": "2023-01-01T10:00+00:00",
  "updated_at": "2023-01-01T10:00+00:00",
  "provider": "provider_123",
  "campaign": "campaign_123",
  "transactional": true,
  "contents": {
    "object": "list",
    "data": [
      {
        "id": "<string>",
        "type": "email",
        "email": {
          "body": "<string>",
          "id": "content_abc",
          "object": "email",
          "subject": "<string>",
          "to": "<string>",
          "from": "<string>",
          "cc": "<string>",
          "bcc": "<string>",
          "locale": "fr-FR",
          "headers": "<string>",
          "preheader_text": "<string>",
          "plain_text": "<string>",
          "processor": {
            "mjml": "<string>",
            "type": "mjml"
          },
          "options": {
            "tracking": true
          },
          "meta": {
            "editor_type": "drag-and-drop"
          }
        },
        "sms": {
          "id": "contents_123",
          "body": "<string>"
        }
      }
    ]
  }
}

Authorizations

​
:cookie
string
header
required

Headers

​
X-Vero-Project-Id
integer
required

Path Parameters

​
id
string
required

Response

OK

​
id
string
Example:

"message_123"

​
object
enum<string>

The resource in the response. Always message.

Available options:
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_123"

​
campaign
string
Example:

"campaign_123"

​
transactional
boolean

Whether this message should respect or ignore the suppression status of recipients.

​
contents
object