Skip to main content
POST
/
api
/
v1
/
campaign
/
create
Create Campaign
curl --request POST \
  --url 'https://api.example.com/api/v1/campaign/create?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "outbound_call",
  "start_time": "2023-11-07T05:31:56Z",
  "interval": 123,
  "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attributes": {},
  "status": "not_started",
  "execution_weekdays": [],
  "time_window_start": "<string>",
  "time_window_end": "<string>",
  "time_zone": "UTC",
  "enabled": false
}
'
{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "type": "outbound_call",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {},
    "status": "not_started",
    "execution_weekdays": [],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "UTC",
    "enabled": false,
    "contacts": [],
    "widget_name": "<string>"
  }
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json
​
name
string
required
​
type
enum<string>
required
Available options:
outbound_call
​
start_time
string<date-time>
required
​
interval
integer
required
​
widget_id
string<uuid> | null
​
attributes
Attributes · object
​
status
enum<string>
default:not_started
Available options:
not_started,
to_be_run,
in_progress,
paused,
cancelled,
completed
​
execution_weekdays
integer[]
​
time_window_start
string<time> | null
​
time_window_end
string<time> | null
​
time_zone
string
default:UTC
​
enabled
boolean
default:false

Response

Successful Response

​
message
string | null
default:Data created successfully
​
meta
Meta · object
​
data
ICampaignRead · object