Skip to Content
Alienmail Docs
Campaigns

Pause a campaign

POST
/campaigns/{id}/pause

Stops sending: emails that were waiting to go out are taken off the queue. Start the campaign again to resume; each lead then continues with their next email. A campaign that is already paused is returned unchanged.

Only an active campaign can be paused. Any other status returns 409.

Requires the CAMPAIGN_STATUS_UPDATE permission.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key of your workspace, from Workspace settings, Integrations. Each key has a role, and the role decides which endpoints it may call.

Path Parameters

id*integer

The campaign id: the number in the campaign URL in Alienmail, or id from the campaign list. An id that is not a campaign of your workspace returns 404.

Response Body

The campaign, now paused.

application/json
  1. response
id*integer

The campaign id, as in the campaign URL in Alienmail.

name*string
status*string
Value in"draft""active""paused""completed""archived"
leadCount*integer

Leads in the campaign. Removed leads are not counted.

sentCount*integer

Emails the campaign has sent, bounced ones included.

lastSentAt*|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://app.alienmail.io/api/v1/campaigns/42/pause'
Example Response
{  "id": 42,  "name": "Q1 outreach",  "status": "active",  "leadCount": 180,  "sentCount": 412,  "lastSentAt": "2026-11-13T09:30:00.000Z",  "createdAt": "2026-11-13T09:30:00.000Z",  "updatedAt": "2026-11-13T09:30:00.000Z"}