Campaigns
Pause a campaign
const url = 'https://app.whatsetter.com/api/v1/campaigns/example/pause';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.whatsetter.com/api/v1/campaigns/example/pause \ --header 'Authorization: Bearer <token>'Pauses an active campaign (AI replies + sending stop). Same effect as
the dashboard toggle. Requires scope campaigns:write.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The campaign id from GET /campaigns
Responses
Section titled “Responses”The paused campaign
object
object
The value used by /leads?campaign_id= and lead objects.
The first name the agent signs with (what people call it).
unknown for an internal value outside this list.
setter = 1:1 conversations; group = a WhatsApp group campaign (its participants are left out of /leads unless filtered). unknown for an internal value outside this list.
Where the agent talks: WhatsApp, Instagram (an account answers with it), Messenger (facebook: a Facebook Page answers with it).
Whether its WhatsApp number can send right now (false for an agent that only talks on Instagram or Messenger).
The knowledge base this agent answers from (GET /knowledge-bases/{id}).
Example
{ "data": { "status": "active", "purpose": "setter", "channels": [ "whatsapp" ] }}Missing, unknown or revoked API key
object
object
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Resource not found in this workspace
object
object
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Campaign is not active
object
object
Examplegenerated
{ "error": { "code": "example", "message": "example" }}