Sign in

v1

latestOpenAPI 3.1.02026-07-122660123.2 KB
Campaigns

Get campaign

get/unified/marketing/campaigns/{id}

Path parameters

idstring required

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable
Example:id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The campaign with the given identifier was retrieved.

Example response

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "schedule_type": {
      "value": "immediate"
    },
    "status": {
      "value": "email"
    },
    "channels": [
      {
        "value": "sms"
      }
    ],
    "first_sent_at": "2021-01-01T01:01:01.000Z",
    "last_sent_at": "2021-01-01T01:01:01.000Z",
    "messages": [
      {
        "id": "message-id-1",
        "name": "SMS Message",
        "message_type": {
          "value": "sms",
          "sourceValue": "sms-message"
        },
        "message_content": {
          "body": "This is an example SMS body.",
          "from": "1-555-123-4567"
        }
      },
      {
        "id": "message-id-2",
        "name": "Email Message",
        "message_type": {
          "value": "email",
          "sourceValue": "email-message"
        },
        "message_content": {
          "subject": "Example Email Subject",
          "body": "<h1>This is an example</h1>\n            <p>email body</p>",
          "from": "Jane Smith",
          "reply-to": "reply@example.com",
          "preheader": "This is the preheader of the email."
        }
      },
      {
        "id": "message-id-3",
        "name": "iOS Push Message",
        "message_type": {
          "value": "ios_push",
          "sourceValue": "ios-push"
        },
        "message_content": {
          "body": "This is an example push notification body."
        }
      }
    ]
  }
}