WhatsApp · WhatsApp Phone Numbers

Resubmit a declined number

Resubmits a declined number.

POSThttps://api.pozy.ai/v1/whatsapp/phone-numbers/{id}/remediate
DeprecatedremediateWhatsAppNumber

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

Path parameters

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • valuesmap of string
  • documentsarray of object

    One of:

    Option 1 (3 fields)
    • requirementIdstringrequired
    • filenamestringrequired
    • base64stringrequired
    Option 2 (2 fields)
    • requirementIdstringrequired
    • documentIdstringrequired
  • addressobject

Example

curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/6bfebd43ddc270f6d2c56fc5/remediate" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "values": {
    "key": "string"
  },
  "documents": [
    {
      "requirementId": "6296509a322aab288a61cc5d",
      "filename": "photo.jpg",
      "base64": "string"
    }
  ],
  "address": {}
}'

Response

200 on success

  • statusstring
  • phoneNumberobject
    • idstring
    • statusstring
200 response
{
  "status": "active",
  "phoneNumber": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active"
  }
}

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 Phone Numbers