Pause a campaign

POST

/campaigns/{id}/pause

curl --request POST \
  --url https://app.whatsetter.com/api/v1/campaigns/example/pause \
  --header 'Authorization: Bearer <token>'

• Production

Pauses an active campaign (AI replies + sending stop). Same effect as the dashboard toggle. Requires scope campaigns:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

The campaign id from GET /campaigns

string

Responses

200

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

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

whatsapp_connected

boolean

created_at

string format: date-time

Example

{
  "data": {
    "status": "active",
    "purpose": "setter"
  }
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Resource not found in this workspace

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Campaign is not active

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}