POST
/
campaigns
curl --request POST \
  --url https://api.charp.ai/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "brand_id": "<string>",
  "name": "<string>"
}'
{
  "campaign_id": "<string>",
  "brand_id": "<string>",
  "name": "<string>",
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2 access token

Body

application/json
Campaign details to create
​
brand_id
string
required

ID of the brand for the campaign

​
name
string
required

Name of the new campaign

Response

200
application/json
Campaign created successfully
​
campaign_id
string
required

Unique identifier of the campaign

​
brand_id
string
required

ID of the brand associated with the campaign

​
name
string
required

Name of the campaign

​
status
enum<string>
required

Current status of the campaign

Available options:
pending,
running,
stopped,
completed