Sign in
Campaigns

Update a campaign

Partially updates a campaign. Only the fields you include are modified.

patch/v2/campaigns/{campaign_id}

Request body

namestring
from_numberstring
time_startstring
time_endstring
timezonestring
contact_list_idinteger
daysCampaignDay[]

Response

Updated campaign.

idinteger required
namestring required
type'outbound' required
status'Running' | 'Scheduled' | 'Stopped' | 'Completed' | 'Failed' | 'Expired' | 'Paused' required
agent_uidstring
from_numberstring
contact_list_idinteger
time_startstring

HH:MM (24-hour) daily window start.

time_endstring

HH:MM (24-hour) daily window end.

timezonestring
daysCampaignDay[]
created_atstring date-time
updated_atstring date-time

Example response

{
  "time_start": "09:00",
  "time_end": "17:00",
  "timezone": "America/New_York"
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.