Campaigns
Campaigns

Control a campaign — start, pause, resume or cancel

Drive the lifecycle of a campaign. Send {action: "<verb>"} where verb is one of:

  • start — begin dialing (campaign moves draft → running)
  • pause — temporarily halt the dialer (running → paused); in-flight calls are allowed to finish
  • resume — pick up where it left off (paused → running)
  • cancel — stop and finalize (any → cancelled); pending contacts will not be called

Common automation pattern: create campaign → upload CSV → start. Pause/resume is useful when integrating with business hours or external pacing logic.

post/v1/campaigns/{campaign_id}/action

Request

  • Base URL: https://api.call2me.app
  • URL: https://api.call2me.app/v1/campaigns/{campaign_id}/action
  • Auth: HTTP bearer

Path parameters

campaign_idstring required

Request body

actionstring required

Response

Confirmation with the new campaign status.

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.