Skip to navigation

Create campaign

View as Markdown

Create a new campaign on the account in the path. The campaign_id is always generated and returned in the response.

Request body fields (wrapped in a campaign object):

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

Any other field is rejected with 400. The account comes from the path and the API key, never from the body.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

account_idstringRequired

Request

This endpoint expects an object.
campaignobjectRequired

Response

Successful response
successboolean
campaignobjectOptional