campaigns.campaigns.create

Save a new campaign draft (name, audience, template, mapping, schedule): nothing is checked beyond its shape and nothing is sent. Answers the draft; then read campaigns.campaigns.estimate and schedule it with campaigns.campaigns.schedule.

curl --request POST \
  --url https://tawked.com/v1/applications/{application}/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience": {
    "any": [
      "<string>"
    ],
    "none": [
      "<string>"
    ],
    "value": "<string>"
  },
  "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-11-07T05:31:56Z",
  "header_image_path": "<string>",
  "mapping": {
    "body": [
      {
        "fallback": "<string>",
        "value": "<string>"
      }
    ],
    "buttons": [
      {
        "fallback": "<string>",
        "value": "<string>"
      }
    ],
    "header": {
      "fallback": "<string>",
      "value": "<string>"
    }
  },
  "name": "<string>",
  "template_language": "<string>",
  "template_name": "<string>",
  "time": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience: {any: ['<string>'], none: ['<string>'], value: '<string>'},
    campaign: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    date: '2023-11-07T05:31:56Z',
    header_image_path: '<string>',
    mapping: {
      body: JSON.stringify([{fallback: '<string>', value: '<string>'}]),
      buttons: [{fallback: '<string>', value: '<string>'}],
      header: {fallback: '<string>', value: '<string>'}
    },
    name: '<string>',
    template_language: '<string>',
    template_name: '<string>',
    time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://tawked.com/v1/applications/{application}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tawked.com/v1/applications/{application}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'audience' => [
        'any' => [
                '<string>'
        ],
        'none' => [
                '<string>'
        ],
        'value' => '<string>'
    ],
    'campaign' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'date' => '2023-11-07T05:31:56Z',
    'header_image_path' => '<string>',
    'mapping' => [
        'body' => [
                [
                                'fallback' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'buttons' => [
                [
                                'fallback' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'header' => [
                'fallback' => '<string>',
                'value' => '<string>'
        ]
    ],
    'name' => '<string>',
    'template_language' => '<string>',
    'template_name' => '<string>',
    'time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/applications/{application}/campaigns"

payload = {
    "audience": {
        "any": ["<string>"],
        "none": ["<string>"],
        "value": "<string>"
    },
    "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date": "2023-11-07T05:31:56Z",
    "header_image_path": "<string>",
    "mapping": {
        "body": [
            {
                "fallback": "<string>",
                "value": "<string>"
            }
        ],
        "buttons": [
            {
                "fallback": "<string>",
                "value": "<string>"
            }
        ],
        "header": {
            "fallback": "<string>",
            "value": "<string>"
        }
    },
    "name": "<string>",
    "template_language": "<string>",
    "template_name": "<string>",
    "time": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

POST

applications

{application}

campaigns

curl --request POST \
  --url https://tawked.com/v1/applications/{application}/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience": {
    "any": [
      "<string>"
    ],
    "none": [
      "<string>"
    ],
    "value": "<string>"
  },
  "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-11-07T05:31:56Z",
  "header_image_path": "<string>",
  "mapping": {
    "body": [
      {
        "fallback": "<string>",
        "value": "<string>"
      }
    ],
    "buttons": [
      {
        "fallback": "<string>",
        "value": "<string>"
      }
    ],
    "header": {
      "fallback": "<string>",
      "value": "<string>"
    }
  },
  "name": "<string>",
  "template_language": "<string>",
  "template_name": "<string>",
  "time": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience: {any: ['<string>'], none: ['<string>'], value: '<string>'},
    campaign: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    date: '2023-11-07T05:31:56Z',
    header_image_path: '<string>',
    mapping: {
      body: JSON.stringify([{fallback: '<string>', value: '<string>'}]),
      buttons: [{fallback: '<string>', value: '<string>'}],
      header: {fallback: '<string>', value: '<string>'}
    },
    name: '<string>',
    template_language: '<string>',
    template_name: '<string>',
    time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://tawked.com/v1/applications/{application}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tawked.com/v1/applications/{application}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'audience' => [
        'any' => [
                '<string>'
        ],
        'none' => [
                '<string>'
        ],
        'value' => '<string>'
    ],
    'campaign' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'date' => '2023-11-07T05:31:56Z',
    'header_image_path' => '<string>',
    'mapping' => [
        'body' => [
                [
                                'fallback' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'buttons' => [
                [
                                'fallback' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'header' => [
                'fallback' => '<string>',
                'value' => '<string>'
        ]
    ],
    'name' => '<string>',
    'template_language' => '<string>',
    'template_name' => '<string>',
    'time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://tawked.com/v1/applications/{application}/campaigns"

payload = {
    "audience": {
        "any": ["<string>"],
        "none": ["<string>"],
        "value": "<string>"
    },
    "campaign": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date": "2023-11-07T05:31:56Z",
    "header_image_path": "<string>",
    "mapping": {
        "body": [
            {
                "fallback": "<string>",
                "value": "<string>"
            }
        ],
        "buttons": [
            {
                "fallback": "<string>",
                "value": "<string>"
            }
        ],
        "header": {
            "fallback": "<string>",
            "value": "<string>"
        }
    },
    "name": "<string>",
    "template_language": "<string>",
    "template_name": "<string>",
    "time": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": {},
  "needs": "<string>",
  "next": "<string>",
  "did_you_mean": [
    {}
  ],
  "human_action": {
    "reason": "connect_whatsapp",
    "url": "<string>",
    "say": "<string>",
    "then": "<string>"
  },
  "approval": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "operation": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

An account token from Settings › Account API in the Tawked console: Authorization: Bearer tk_acct_…

Headers

Idempotency-Key

string

One per intended change (1 to 128 printable ASCII characters): a retry with the same key and the same request answers the stored 2xx with Idempotent-Replayed: true, for 24 hours. A 428 approval_required is never stored: send the approved request again with the same key or none. An answer that carried a secret shown once is never kept: its replay answers 409 idempotency_secret_not_replayable with the id of what it made.

Required string length: 1 - 128

Path Parameters

application

string

required

An application's id (a UUID); list them with applications.applications.list.

Pattern: ^(?:[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})$

Body

application/json

audience

object | null

Show child attributes

campaign

string<uuid> | null

date

string<date-time> | null

header_image_path

string | null

Maximum string length: 255

intent

enum<string>

Available options:

draft,

schedule

mapping

object | null

Show child attributes

name

string | null

Maximum string length: 120

send_mode

enum<string>

Available options:

now,

later

template_language

string | null

Maximum string length: 16

template_name

string | null

Maximum string length: 512

time

string<date-time> | null

Response

Created.

data

object

required