WhatsApp · WhatsApp

Register a connected WhatsApp number on the Cloud API

Registers a connected WhatsApp number on the Cloud API.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/whatsapp/register
registerWhatsAppNumber

Guides: Phone numbers for WhatsApp, WhatsApp

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Request body

application/json, optional

  • pinstring

    Matches ^\d{6}$.

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/whatsapp/register" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pin": "string"
}'

Response

200 on success

  • registeredboolean
  • accountIdstring
  • phoneNumberIdstring
200 response
{
  "registered": true,
  "accountId": "696e0b682d0a31188e7a2ba9",
  "phoneNumberId": "698fba0989716df44adb771f"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp