Sign in
Campaigns

Pause a campaign

Pause a running campaign, transitioning it from RUNNING to PAUSED.

Only campaigns in RUNNING status can be paused. Attempting to pause a
campaign in any other status (e.g. DRAFT) returns 400.

Returns the campaign ID and new status on success.

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

Request

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

Path parameters

campaign_idstring uuid required

Response

Campaign paused successfully

unknown required

Changes

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