WhatsApp · WhatsApp

Unblock users

Unblocks users.

DELETEhttps://api.pozy.ai/v1/whatsapp/block-users
unblockWhatsAppUsers

Guide: Connect WhatsApp

Request

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

Request body

application/json, required

  • accountIdstringrequired
  • usersarray of stringrequired

    At least 1 item. Up to 1000 items.

Example

curl -X DELETE "https://api.pozy.ai/v1/whatsapp/block-users" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "users": [
    "string"
  ]
}'

Response

200 on success

  • unblockedarray of object
    • inputstring
    • waIdstring
  • failedarray of object
    • inputstring
    • errorsarray of string
200 response
{
  "unblocked": [
    {
      "input": "string",
      "waId": "69ef3ad4754e098d2b7245dd"
    }
  ],
  "failed": [
    {
      "input": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

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