Skip to main content
POST
Deregister the number

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Path Parameters

connection
string<uuid>
required

The connection uuid.

Response

Deregistered.

uuid
string<uuid>
phone_number_id
string
Example:

"106540352242922"

display_phone_number
string
Example:

"+919812345670"

verified_name
string | null

Display name customers see.

waba_id
string

WhatsApp Business Account (Meta’s Messaging account) id.

messaging_account_id
string | null
mode
enum<string>
Available options:
live,
test
is_default
boolean
status
enum<string>
Available options:
active,
attention_required,
disconnected,
revoked,
phone_registration_pending,
signup_started,
code_exchange_pending,
asset_discovery,
webhook_subscription_pending,
authorization_received,
draft
connected_via
enum<string> | null
Available options:
embedded_signup,
manual,
platform_sync,
platform_claim,
null
coexistence
boolean

Also used in the WhatsApp Business app (fixed 20 messages a second).

quality_rating
string | null
Example:

"GREEN"

messaging_limit
string | null

Shared by every number in the business portfolio.

Example:

"TIER_2K"

throughput_level
string | null
Example:

"STANDARD"

code_verification_status
string | null
Example:

"VERIFIED"

registration_status
enum<string> | null
Available options:
registered,
deregistered,
pending,
null
two_step_pin_set
boolean
marketing_messages_status
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null