Skip to main content
POST
/
campaigns
/
{campaignId}
/
pause
Pause a campaign
curl --request POST \
  --url https://api.altahq.com/v1/campaigns/{campaignId}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pauseProspects": true
}
'
{
  "error": "Unauthorized",
  "message": "Invalid API token"
}
Pauses an active campaign, halting outreach to all prospects. Resume with Resume a campaign.

Authorizations

​
Authorization
string
header
required

API token authentication. Generate a token from the Alta dashboard and pass it as a Bearer token in the Authorization header.

Path Parameters

​
campaignId
string<uuid>
required

The UUID of the campaign to pause.

Body

application/json
​
pauseProspects
boolean

When true, also pauses all active prospect workflows in the campaign.

Response

Campaign paused successfully