Skip to contentSkip to navigation

Pause Campaign

Pause an active campaign. No more emails will be sent until resumed.

POST /api/v1/campaigns/{campaign_id}/pause

Path Parameters

campaign_id string path required

The unique identifier of the campaign.

Response

Returns the updated campaign object with status: "paused".

Errors

StatusDescription
400Only active campaigns can be paused
404Campaign not found

Rate Limit

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Was this page helpful?