Skip to content
Dashboard

Pause a campaign

POST
/campaigns/{id}/pause
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.

id
required

The campaign id from GET /campaigns

string

The paused campaign

Media typeapplication/json
object
data
object
id
string
campaign_id

The value used by /leads?campaign_id= and lead objects.

string | null
name
string | null
agent_name

The first name the agent signs with (what people call it).

string | null
status

unknown for an internal value outside this list.

string | null
Allowed values: active draft paused archived unknown
purpose

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.

string | null
Allowed values: setter group unknown
channels

Where the agent talks: WhatsApp, Instagram (an account answers with it), Messenger (facebook: a Facebook Page answers with it).

Array<string>
Allowed values: whatsapp instagram facebook
whatsapp_connected

Whether its WhatsApp number can send right now (false for an agent that only talks on Instagram or Messenger).

boolean
knowledge_base_id

The knowledge base this agent answers from (GET /knowledge-bases/{id}).

string | null
created_at
string format: date-time
Example
{
"data": {
"status": "active",
"purpose": "setter",
"channels": [
"whatsapp"
]
}
}

Missing, unknown or revoked API key

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Resource not found in this workspace

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Campaign is not active

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}