WhatsApp · WhatsApp Phone Numbers

Purchase phone number

Purchases a phone number.

POSThttps://api.pozy.ai/v1/whatsapp/phone-numbers/purchase
DeprecatedpurchaseWhatsAppPhoneNumber

Request

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

Request body

application/json, required

  • profileIdstringrequired
  • countrystring

    Default US.

  • phoneNumberstring

    Matches ^\+[1-9]\d{6,14}$.

  • purchaseIntentIdstring

    Up to 100 characters.

  • allowMultipleboolean

    Default false.

Example

curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/purchase" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profileId": "6a0b6573846efc28aaa9a3ff"
}'

Response

200 on success

200 response
{
  "message": "Hello from Pozy",
  "checkoutUrl": "https://pozy.ai/media/example-1.jpg"
}

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.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp Phone Numbers