Campaigns

Pause campaign

Pause an active campaign. In-flight sends finish; nothing new is scheduled.

Requires one of the following scopes: campaigns:lifecycle, campaigns:all, all:all.

post/v1/campaigns/{id}/pause

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns/{id}/pause
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60

Headers

Idempotency-Keystring
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Optional. A unique key you generate (max 255 chars, such as a UUID) that makes this request safe to retry. Retrying with the same key replays the original response instead of repeating the operation. Reusing a key with a different body returns 422.

Response

idstring uuid required
status'draft' | 'scheduled' | 'active' | 'paused' | 'stopped' | 'completed' | 'failed' required
successboolean required

Example response

{
  "id": "a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60",
  "status": "paused",
  "success": true
}

Changes

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