Get campaign

curl --request GET \
  --url https://api.stackone.com/unified/marketing/campaigns/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "<string>",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "description": "<string>",
    "schedule_type": {
      "value": "immediate",
      "source_value": "Immediate"
    },
    "status": {
      "value": "email",
      "source_value": "Email"
    },
    "archived": true,
    "draft": true,
    "channels": [
      {
        "value": "sms",
        "source_value": "SMS"
      }
    ],
    "first_sent_at": "2021-01-01T01:01:01.000Z",
    "last_sent_at": "2021-01-01T01:01:01.000Z",
    "tags": [
      "<string>"
    ],
    "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": "[email protected]",
          "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."
        }
      }
    ]
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

marketing

campaigns

{id}

Get campaign

curl --request GET \
  --url https://api.stackone.com/unified/marketing/campaigns/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "<string>",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "description": "<string>",
    "schedule_type": {
      "value": "immediate",
      "source_value": "Immediate"
    },
    "status": {
      "value": "email",
      "source_value": "Email"
    },
    "archived": true,
    "draft": true,
    "channels": [
      {
        "value": "sms",
        "source_value": "SMS"
      }
    ],
    "first_sent_at": "2021-01-01T01:01:01.000Z",
    "last_sent_at": "2021-01-01T01:01:01.000Z",
    "tags": [
      "<string>"
    ],
    "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": "[email protected]",
          "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."
        }
      }
    ]
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

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

proxy

object

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

fields

string | null

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

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"

Response

The campaign with the given identifier was retrieved.

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.name

string | null

data.created_at

string<date-time> | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string<date-time> | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

data.description

string | null

data.schedule_type

object

The schedule type

Show child attributes

data.schedule_type.value

enum<string> | null

The schedule type of the campaign.

Available options:

immediate,

scheduled,

recurring,

custom,

triggered,

unmapped_value,

Example:

"immediate"

data.schedule_type.source_value

The source value of the schedule type.

Example:

"Immediate"

data.status

object

Status of the Campaign

Show child attributes

data.status.value

enum<string> | null

The Status of the campaign.

Available options:

draft,

archived,

live,

unmapped_value,

Example:

"email"

data.status.source_value

The source value of the Status.

Example:

"Email"

data.archived

data.draft

data.channels

object[] | null

channels of the Campaign

Show child attributes

data.channels.value

enum<string> | null

The Channels of the campaign.

Available options:

email,

sms,

web_push,

ios_push,

android_push,

unknown,

unmapped_value,

Example:

"sms"

data.channels.source_value

The source value of the Channels.

Example:

"SMS"

data.first_sent_at

string<date-time> | null

The first_sent_at date

Example:

"2021-01-01T01:01:01.000Z"

data.last_sent_at

string<date-time> | null

The last_sent_at date

Example:

"2021-01-01T01:01:01.000Z"

data.tags

string[] | null

data.messages

object[] | null

Show child attributes

data.messages.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.messages.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.messages.name

string | null

data.messages.message_type

object

Stackone enum identifying the type of message associated with the content.

Show child attributes

data.messages.message_type.value

enum<string> | null

The unified message type.

Available options:

email,

sms,

push,

web_push,

ios_push,

android_push,

app_push,

omni_channel,

content_block,

in_app,

unknown,

unmapped_value,

Example:

"email"

data.messages.message_type.source_value

The original value from the provider used to derive the unified message type.

Example:

"Email"

data.messages.message_content

object

Option 1
Option 2
Option 3

Show child attributes

data.messages.message_content.body

string | null

data.messages.message_content.from

string | null

Example:

[
  {
    "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": "[email protected]",
      "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."
    }
  }
]

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

List campaigns List Content Blocks

⌘I

Getting Started

API Reference

Get campaign

Authorizations

Headers

Path Parameters

Query Parameters

Response