Developers
Open Swarmhit
DocumentationAPI Reference
Whatsapp accounts
POST
/whatsapp-accounts/{id}/pause

Campaigns stop sending from the number until it is resumed; its leads stay assigned, and replies still arrive. Emits account.paused with channel: whatsapp.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/whatsapp-accounts/string/pause"
{  "data": {    "id": "string",    "label": "string",    "phoneNumber": "string",    "name": "string",    "picture": "string",    "isBusiness": true,    "connectedVia": "app",    "status": "pending",    "connection": "connected",    "error": "string",    "errorCode": "string",    "paused": true,    "pausedReason": "string",    "pausedAt": "2019-08-24T14:15:22Z",    "connectedAt": "2019-08-24T14:15:22Z",    "linkedAt": "2019-08-24T14:15:22Z",    "limits": {      "newChats": 0,      "followUps": 0,      "checks": 0    },    "limitsToday": {      "newChats": 0,      "followUps": 0,      "checks": 0    },    "usage": {},    "warmup": {      "enabled": true,      "status": "off",      "start": 0,      "step": 0,      "everyDays": 0,      "day": 0,      "newChatsToday": 0,      "target": 0,      "quietUntil": "2019-08-24T14:15:22Z",      "fullSpeedAt": "2019-08-24T14:15:22Z"    },    "newChatQuota": {      "total": 0,      "used": 0,      "status": "NONE",      "cycleEndsAt": "2019-08-24T14:15:22Z"    },    "newChatsPausedUntil": "2019-08-24T14:15:22Z",    "restriction": {      "active": true,      "endsAt": "2019-08-24T14:15:22Z",      "type": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

List WhatsApp numbers GET

Linked WhatsApp numbers, newest first: status, connection, today's caps (the warm-up applied), usage, warm-up, and WhatsApp's own limits on the number (its new-chat quota and its block on new chats).

Scan again POST

A new QR code (or pairing code) for a number that was logged out, or for a link that expired. Its campaigns and chats carry on once it is linked again. Scanned by another phone than its own number, the link is undone.