Skip to main content
POST
social.connect.whatsapp.credentials

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
accessToken
string
required

A permanent system-user access token for the business account, with the WhatsApp permissions. Forwarded once so the connection can be verified and kept; not stored or logged by this API, and never in a result or an error.

Required string length: 1 - 1024
wabaId
string
required

The WhatsApp business account's id.

Required string length: 1 - 256
phoneNumberId
string
required

The phone number's id, from that business account.

Required string length: 1 - 256
pin
string

The number's two-step verification PIN, when one is set. Forwarded once; not stored or logged by this API.

Required string length: 1 - 6
Pattern: ^\d{6}$

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.

phoneNumber
string

The connected number.

verifiedName
string

The verified business name for the number.

qualityRating
string

green, yellow, red or unknown.

registrationPending
boolean

True when the account connected but the number's cloud registration was refused: it cannot send until that is resolved in the number's settings.

webhookMoved
boolean

True when the number's message events moved to this connection's subscription as part of connecting.