Skip to main content
PUT
/
api
/
v1
/
campaigns
/
{campaign_id}
/
status
Update Campaign
curl --request PUT \
  --url https://api.kollie.ai/api/v1/campaigns/{campaign_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "draft"
}
'
{
  "message": "Data updated correctly",
  "meta": {},
  "data": {
    "name": "<string>",
    "end_date": "2023-11-07T05:31:56Z",
    "start_time": "<string>",
    "end_time": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "draft",
    "start_date": "2023-11-07T05:31:56Z",
    "phone_numbers": [],
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "additional_params": {}
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

campaign_id
string<uuid>
required

Body

application/json
status
enum<string>
required
Available options:
draft,
paused,
running,
finished,
canceled

Response

Successful Response

message
string | null
default:Data updated correctly
meta
Meta · object
data
ICampaignRead · object