Sign in
Campaigns

Create a campaign

post/api/v1/campaigns

Request body

namestring required

Campaign name.

type'inbound' | 'outbound' required

Campaign type. inbound: receives calls on a phone number. outbound: dials contacts from a contact list.

bot_uidstring required

UID of the bot that handles calls for this campaign.

phone_number_idinteger

ID of the phone number to use. Required for inbound campaigns.

contact_list_idinteger

ID of the contact list to dial. Required for outbound campaigns.

daily_budget_usdnumber

Maximum daily spend in USD for outbound campaigns.

time_startstring required

Start time for the campaign calling window (e.g. "09:00").

time_endstring required

End time for the campaign calling window (e.g. "17:00").

timezonestring

IANA timezone for the calling window (e.g. "America/New_York"). Defaults to UTC if not specified.

Response

Campaign created

idinteger

Unique identifier.

namestring

Campaign name.

typestring

Campaign type (inbound or outbound).

activeboolean

Whether the campaign is currently active.

bot_idinteger

Internal bot ID.

bot_uidstring

Bot UID for API reference.

phone_number_idinteger

Associated phone number ID.

contact_list_idinteger

Associated contact list ID.

daily_budget_usdnumber

Daily budget in USD.

time_startstring

Calling window start time.

time_endstring

Calling window end time.

timezonestring

Calling window timezone.

created_atstring date-time
updated_atstring date-time

Changes