Create campaign

POST /v1/accounts/{accountId}/campaigns

cURL

cURL

curl -X POST \
  https://api.sakari.io/v1/accounts/{{ACCOUNT_ID}}/campaigns \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Marketing Campaign",
  "trigger": {
    "code":"M"
  },
  "template":"Hi {{{contact.firstName}}}",
  "reporting":{"when":"NoReport"}
}'

201

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "fieldMappings": [
      {
        "attribute": "<string>",
        "column": "<string>",
        "mandatory": true
      }
    ],
    "filters": {
      "list": {
        "id": "<string>",
        "name": "<string>",
        "keyword": "<string>",
        "doubleOptIn": {
          "enabled": true,
          "prompt": "<string>"
        },
        "filter": {
          "q": "<string>",
          "attributes": [
            {
              "attribute": "<string>",
              "comparator": "<string>",
              "value": [
                "<string>"
              ]
            }
          ],
          "list": "<string>",
          "valid": true,
          "invalid": true,
          "blocked": true,
          "unblocked": true,
          "optIn": true
        },
        "optInConfirmation": "<string>"
      },
      "q": "<string>",
      "attributes": [
        {
          "attribute": "<string>",
          "comparator": "<string>",
          "value": [
            "<string>"
          ]
        }
      ],
      "tags": [
        {
          "tag": "<string>",
          "visible": true
        }
      ]
    },
    "media": [
      {
        "url": "<string>",
        "type": "<string>",
        "name": "<string>",
        "filename": "<string>"
      }
    ],
    "phoneNumberFilter": {
      "group": {
        "id": "<string>"
      }
    },
    "nextExecution": "<string>",
    "template": "<string>",
    "trigger": {
      "code": "<string>",
      "name": "<string>"
    },
    "paused": "<string>"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId · string · required

Account to apply operations to

Body

application/json

trigger · object

Show child attributes

filters · object

Show child attributes

template · string

Response

201

application/json

successful operation

success · boolean · required

data · object · required

Show child attributes