Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

phoneNumberId
string
required

Unique identifier for a WhatsApp Phone Number. Format: wapn_[test_]{ksuid}

Pattern: ^wapn_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
appIds
string[]
required

Array of app IDs to assign the phone number to

Example:

Response

WhatsApp phone number app assignments updated successfully

id
string
required

Unique identifier for a WhatsApp Phone Number. Format: wapn_[test_]{ksuid}

Pattern: ^wapn_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

displayPhoneNumber
string
required
metaPhoneNumberId
string
required
metaBusinessAccountId
string
required
verified
boolean
required
qualityRating
string | null
required
throughputTier
string | null
required

Messaging throughput tier from phone_number_quality_update (e.g. STANDARD, HIGH)

qualityEvent
string | null
required

Most recent quality event (e.g. FLAGGED, ONBOARDED, UPGRADE)

qualityEventAt
string<date-time> | null
required
nameStatus
string | null
required

Display name verification status (APPROVED, REJECTED, PENDING, DEFERRED)

requestedVerifiedName
string | null
required
nameRejectionReason
string | null
required
nameDecisionAt
string<date-time> | null
required
isTestNumber
boolean
required
cloudApiRegistered
boolean
required

Whether the phone number has been registered with Meta Cloud API (two-step verification)

businessProfile
object | null
required

The WhatsApp Business Account (WABA) this phone number belongs to

apps
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required