Skip to main content
POST
Refresh a WhatsApp number

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Response

The number, as Meta reports it now

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
whatsapp_account
name
string
required
display_phone_number
string
required
Example:

"+91 98765 43210"

verified_name
string
required

The business name WhatsApp shows.

phone_number_id
string
required

Meta’s id for the number.

waba_id
string
required

Meta’s id for the WhatsApp Business Account the number belongs to.

quality_rating
string
required

GREEN, YELLOW, RED or UNKNOWN, as Meta rates the number.

Example:

"GREEN"

messaging_limit_tier
string | null
required

How many people the number may start conversations with per day.

Example:

"TIER_1K"

connection
enum<string>
required

embedded_signup when connected in the console with Meta’s sign-up; manual when connected with your own Meta app’s token.

Available options:
embedded_signup,
manual
coexistence
boolean
required

The number also stays on the WhatsApp Business app.

status
enum<string>
required
Available options:
connected,
error,
disconnected
last_error
string | null
required
webhook
object
required
inbound_agent_id
string | null
required

The agent that answers this number’s chats. With none, messages are stored and not answered.

Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

settings
object
required
created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

updated_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"