Campaigns

Update a campaign

patch/api/v1/campaigns/{campaign_id}

Path parameters

campaign_idinteger required

Request body

namestring

Campaign name.

daily_budget_usdnumber

Maximum daily spend in USD.

time_startstring

Start time for the calling window.

time_endstring

End time for the calling window.

timezonestring

IANA timezone for the calling window.

contact_list_idinteger nullable

ID of the contact list. Pass null to disconnect.

phone_number_idinteger nullable

ID of the phone number. Pass null to disconnect.

Response

Updated campaign

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