Skip to main content
POST
/
campaigns
/
{campaign_id}
/
start
Start Campaign
curl --request POST \
  --url https://api.kejue.co/api/v1/campaigns/{campaign_id}/start \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scheduled_start_at": "<string>"
}
'
{
  "error": "Campaign cannot be started: invalid status or no contacts",
  "code": "BAD_REQUEST",
  "details": {}
}

Authorizations

​
X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Path Parameters

​
campaign_id
string
required

Body

application/json

Start a campaign.

​
scheduled_start_at
string | null

Naive datetime 'YYYY-MM-DDTHH:MM' per contact timezone

Response

Successful Response