Skip to main content
POST
/
v1
/
campaigns
/
{id}
/
pause
Pause Campaign
curl --request POST \
  --url https://api.example.com/v1/campaigns/{id}/pause
{
  "data": {
    "campaign": {
      "id": "<string>",
      "status": "<string>",
      "paused_at": "<string>"
    }
  }
}

​
Request

​
Path Parameters

​
id
string
required
The campaign’s unique ID (UUID)

​
Headers

Authorization: Bearer wbk_your_api_key_here
Requires an API key with the campaigns:write permission. The campaign must currently be in active status. Fires the campaign.paused webhook event.

​
Response

​
data
object
curl -X POST https://data.leadlex.com/functions/v1/api-gateway/v1/campaigns/cmp_abc123/pause \
  -H "Authorization: Bearer wbk_your_api_key_here"

​
Example Response

{
  "data": {
    "campaign": {
      "id": "cmp_abc123",
      "status": "paused",
      "paused_at": "2026-04-17T14:30:00Z"
    }
  }
}
To resume a paused campaign, call POST /v1/campaigns/{id}/start.

​
Errors

StatusCodeDescription
401invalid_keyInvalid or expired API key
403insufficient_permissionsMissing campaigns:write permission
404campaign_not_foundNo campaign with this ID
409campaign_not_activeCampaign is not in active status
429rate_limitedRate limit exceeded