Skip to main content
POST
/
api
/
v1
/
phone-numbers
/
{number}
/
unsubscribe
/
cURL
curl --request POST \
  --url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/phone-numbers/{number}/unsubscribe/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "number": "<string>",
  "whatsappPhoneNumberId": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "<string>",
  "whatsappPhoneNumberId": "<string>",
  "whatsappBusinessAccount": "<string>",
  "activeAgent": "<string>",
  "defaultRouting": "<string>",
  "defaultWebhook": "<string>",
  "isSandbox": true
}
Sets defaultRouting to null (no routing) and drops both the connected agent and the default webhook. Incoming messages are stored on the conversation but no agent or webhook is invoked. When applyToExisting is true, every existing conversation on this number has its activeAgent and in-flight session cleared too. Phone- number routing changes do not dispatch subscription.activated / subscription.revoked webhook events. Sandbox numbers scope the change to the requesting user’s own conversation rather than the shared number’s defaults.

Authorizations

​
X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Path Parameters

​
number
string
required

Body

application/json

Serializer for WhatsappNumber model.

​
number
string
required
Maximum string length: 15
​
whatsappPhoneNumberId
string
required

Response

200 - application/json

Serializer for WhatsappNumber model.

​
id
string<uuid>
required
read-only
​
number
string
required
Maximum string length: 15
​
whatsappPhoneNumberId
string
required
​
whatsappBusinessAccount
string
required
read-only
​
activeAgent
string
required
read-only
​
defaultRouting
string
required
read-only
​
defaultWebhook
string
required
read-only
​
isSandbox
boolean
required
read-only