Unblock users

Unblocks one or more previously blocked WhatsApp users on the app, using a JSON list of phone numbers in the body.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
messaging_productAlways "whatsapp"whatsapp—Required
block_usersThe numbers to act on. The unblock response reports these as removed_users.——Required

Sample cURL — Unblock users.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/access/users/unblock' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "messaging_product" : "whatsapp",
  "block_users" : [ {
    "user" : "91XXXXXXXX73"
  } ]
}'

Sample success response (200)

{
  "status": "success",
  "data": {
    "messaging_product": "whatsapp",
    "block_users": {
      "removed_users": [
        {
          "input": "91XXXXXXXX73",
          "wa_id": "91XXXXXXXX73"
        }
      ]
    }
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Body Params

Phone numbers to unblock. Same shape as the block request; the response reports removed_users.

Numbers to block or unblock

string
enum
required

Always "whatsapp"

Allowed:
block_users
array of objects
required

The numbers to act on. The unblock response reports these as removed_users.

block_users*
Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json