Skip to main content
​
id
string
Example: campaign_123Match pattern: campaign_\d+
​
object
string
The resource in the response. Always campaign.Allowed value: campaign
​
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
​
title
string
required
The internal title of the campaign. Not shown to recipients.Example: Product update announcement: New features go live!
​
action
object
Currently only supports type message but will support workflow in the future.
​
trigger
string | Trigger
One of:
​
audience
string
The v1 API ID of a DataImport. Will be updated in future versions.Example: audience_123Match pattern: audience_\d+
​
campaign_runs
array
An array of Campaign Run objects.

​
Example

{
  "id": "campaign_123",
  "object": "campaign",
  "created_at": "2023-01-01T10:00+00:00",
  "updated_at": "2023-01-01T10:00+00:00",
  "title": "Product update announcement: New features go live!",
  "action": {
    "type": "message",
    "message": {
      "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": true,
      "contents": {
        "object": "list",
        "data": []
      }
    }
  },
  "trigger": "trigger_123",
  "audience": "audience_123",
  "campaign_runs": []
}