Campaigns

Start a campaign

Moves a draft/paused campaign into running (or scheduled, when startDate is in the future). A completed campaign starts again only when new prospects have been enrolled in it (otherwise 400 nothing_new_to_send). No request body. Before starting, the campaign runs the same configuration check as the Launch button in the app — sequences that would strand prospects mid-flow are rejected with 400 campaign_validation_failed and the offending steps listed.

Required scope: campaigns:write.

post/campaigns/{id}/start

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/campaigns/{id}/start
  • Auth: HTTP bearer

Path parameters

idstring required

Campaign id (UUID).

Query parameters

force'1' | 'true'

Launch even though the configuration check found problems — the headless equivalent of "Launch anyway" in the app. Omit unless you have reviewed the reported violations.

Response

Success

Changes

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