Skip to navigation

Update campaign

View as Markdown

Update a campaign. Send only the fields you want to change; at least one is required.

Request body fields (wrapped in a campaign object, all optional):

  • name (string) - Campaign name, up to 200 characters.
  • seats (array of strings) - Ids of the seats on this account that run the campaign. Replaces the current list.
  • schedule (object) - Sending hours for every day, monday to sunday. Each day is [enabled (boolean), start_hour (0-23), end_hour (1-24)]. Replaces the whole schedule.
  • status (string) - DRAFT, RUN, PAUSED or ARCHIVED.
  • timezone (integer) - UTC offset in minutes (e.g. -300 = UTC-5).
  • agent_outreach_mode (string) - auto (Full Autopilot), outbound (Outbound Autopilot) or manual (Co-pilot, AI drafts wait for your approval).

Any other field is rejected with 400. The account and campaign come from the path.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

account_idstringRequired
campaign_idstringRequired

Request

This endpoint expects an object.
campaignobjectRequired

Response

Successful response
successboolean
campaignobjectOptional
campaign_oldobjectOptional
updated_fieldsmap from strings to objectsOptional
Changed public fields, keyed by field name.