get
https://partner.gupshup.io/partner/bizgate/app//access/users/blocked
Returns the WhatsApp phone numbers currently blocked from messaging the app, with cursor-based pagination via the limit and after parameters.
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
Query parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| limit | Maximum number of records to return in one page. | 20 | Integer | Optional |
| after | Cursor returned by a previous page; fetches the records after it. | — | String | Optional |
Sample cURL — List blocked users.
curl --request GET \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/access/users/blocked?limit=20' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json'Sample success response (200)
{
"status": "success",
"data": {
"users": [
{
"phone": "91XXXXXXXX10",
"blocked": true
},
{
"phone": "91XXXXXXXX78",
"blocked": true
}
]
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…