Skip to main content
POST
social.connect.whatsapp.embedded.code.redeem

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
code
string
required

The authorization code the embedded signup popup reported when the person finished.

Required string length: 1 - 1024
wabaId
string

The business account id the popup reported, when it did.

Required string length: 1 - 256
phoneNumberId
string

The phone number id the popup reported, when it did: exactly that number is connected.

Required string length: 1 - 256
isCoexistence
boolean

The number also lives in the WhatsApp Business app.

expectedPhoneNumber
string

Refuse the connection when the platform reports a different number.

Required string length: 1 - 64

Response

The result

accountId
string
required

Use with whatsapp.message.send and whatsapp.template.send.

platform
string
required

Lowercase platform name.

handle
string

The display phone number.

displayName
string

The verified business name.

selectedPhoneNumber
string

The connected number.