POST
/
campaigns
/
create
curl --request POST \
  --url https://api.callab.ai/v1/campaigns/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "notes": "<string>",
  "campaign_type": "<string>",
  "contacts_list_source": [
    "<string>"
  ],
  "contacts_list_tags": [
    "<string>"
  ],
  "contacts_list_categories": [
    "<string>"
  ],
  "contacts_list_source_metadata": {},
  "agent_variables_contact_metadata_mapping": {},
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_time_of_day_from": "<string>",
  "call_time_of_day_to": "<string>",
  "number_of_call_attempts": [
    123
  ],
  "retry_delay": [
    123
  ],
  "retry_delay_unit": [
    "<string>"
  ],
  "days_of_week": [
    123
  ],
  "time_zone": "<string>",
  "inbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "started_at": "2023-12-25",
  "ended_at": "2023-12-25",
  "webhook_mapping_variables": {},
  "webhook_mapping_variables_sources": {},
  "workspace": "<string>"
}'
{
  "status": "<string>",
  "message": "<string>",
  "data": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The campaign to create.

Data for creating a new campaign.

Response

200
application/json

Campaign created successfully.

The response is of type object.