Create campaign

Returns the campaign in pending state. Requires campaigns:write.

Request

curl -X POST "https://api.blueticks.co/v1/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "audience_id": "string"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "audience_id": "string",
    "status": "pending",
    "total_count": 0,
    "sent_count": 0,
    "delivered_count": 0,
    "read_count": 0,
    "failed_count": 0,
    "from": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "aborted_at": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "path": "string",
        "code": "string",
        "message": "string"
      }
    ]
  }
}

Request Body

application/json

name*string

Display name for the campaign.

Length1 <= length <= 120

audience_id*string

ID of the audience to target. Each audience contact contributes one outgoing message.

Length1 <= length

text?string

Message body. Supports per-contact substitution using single-brace tokens like {firstName} or {product}. Resolution rules (case-insensitive, whitespace stripped):

Built-ins always available: {whatsappname} (WA profile name), {displayname} (firstname+lastname fallback), {phone} / {mobile}.
Custom variables: every property attached to a contact via audiences.append_contacts becomes a token of the same name.
Unresolved tokens are left as literal {token} in the sent message. Templates use SINGLE braces {var} — {{var}} is treated as literal text.

Length1 <= length <= 4096

media_url?string

Public https URL of an image/video/document to attach.

Formaturi

Lengthlength <= 2048

media_caption?string

Caption for the media attachment. Requires media_url.

Length1 <= length <= 1024

from?string

Sender phone in international format (e.g. +14155551234). When omitted, the workspace default sender is used.

Match^\+[1-9]\d{6,14}$

on_missing_variable?string

Behavior when a template references a variable that is not present on a contact:

fail (default): reject the request at create time; no messages are sent. Returns 400 with data.examples listing offending contacts.
skip: accept the campaign; contacts missing variables receive the message with literal {token} left in place.

Value in"fail" | "skip"

Create campaign

Request

Request Body

Response

Response Body

`application/json`

`application/json`

Create campaign

Request

Request Body

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`