Sign in
Campaigns

Stop a campaign

Stop a running or paused campaign, transitioning it to STOPPED.

Only campaigns in RUNNING or PAUSED status can be stopped. Stopping is
irreversible — a stopped campaign cannot be restarted.

Returns the campaign ID and new status on success.

Authentication:
- API key with READ_WRITE permission
post/campaigns/{campaign_id}/stop

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/campaigns/{campaign_id}/stop
  • Auth: API Key (a scheme the document does not define)

Path parameters

campaign_idstring uuid required

Response

Campaign stopped successfully

unknown required

Changes

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