v1

latestOpenAPI 3.0.02026-08-067926202.5 KB

Campaigns

Create a Campaign

post/campaigns

Request body

Example request

{
  "campaign": {
    "optional_suppression_list_uids": [
      "optional_suppression_list_uid"
    ],
    "list_uids": [
      "list_uid"
    ],
    "segment_uids": [
      "segment_uid"
    ],
    "exclude_list_uids": [
      "list_uid"
    ],
    "exclude_segment_uids": [
      "segment_uid"
    ],
    "sender_uid": "sender_uid",
    "template": {
      "content": "Campaign content that has been converted to Base64",
      "template_uid": "Template will override content",
      "only_plain_text": "no",
      "auto_plain_text": "yes",
      "plain_text": "The plain text that has been converted to Base64"
    },
    "options": {
      "preheader": null
    }
  }
}

Response

Request success

status'success' | 'error'

campaign_uidstring

Example response

{
  "status": "success"
}