List Blacklist POST
Returns the numbers in your account's blacklist, paginated, with optional search by number or reason.
Authorization
API Key (Authentication) — send the header Authorization: Bearer <API_KEY> (API keys start with smsk_)
HTTP Request
http
POST https://public-api.smsup-plus.com/Blacklist/requestBlacklistContent Type
application/json — the body is optional; if it is missing or not valid JSON, all defaults apply
Parameter Description
| Property | Type | Required | Description |
|---|---|---|---|
search | string | Optional | Case-insensitive partial match on mobile and reason |
page | number | Optional | Page number, starting at 1 (default 1) |
pageSize | number | Optional | Items per page, 1–100 (default 50) — 101–200 is treated as 20; any other out-of-range value as 50 |
Response Description
| Property | Type | Description |
|---|---|---|
status | number | 200 on success |
data | array | null | List of Blacklist entries, newest first — null when nothing matches |
total | number | Total number of matching entries |
page | number | Current page |
pageSize | number | Page size actually applied |
totalPages | number | Total number of pages |
Blacklist
| Property | Type | Description |
|---|---|---|
accountId | number | Your account ID |
mobile | string | Blacklisted number |
reason | string | Reason (may be empty) |
source | string | Where it was added — api when added through this API |
createdBy | number | ID of the user who added it |
createdAt | string | Time added (ISO 8601) |
Request Example
bash
curl -X POST 'https://public-api.smsup-plus.com/Blacklist/requestBlacklist' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"search": "66812",
"page": 1,
"pageSize": 50
}'js
const res = await fetch('https://public-api.smsup-plus.com/Blacklist/requestBlacklist', {
method: 'POST',
headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
body: JSON.stringify({ search: '66812', page: 1, pageSize: 50 }),
})
console.log(await res.json())Response Example
json
{
"status": 200,
"data": [
{
"accountId": 1024,
"mobile": "66812345678",
"reason": "Customer opted out",
"source": "api",
"createdBy": 2048,
"createdAt": "2026-11-16T03:30:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 50,
"totalPages": 1
}Possible Errors
| HTTP | Response | Cause |
|---|---|---|
| 200 | {"status":500,"description":"Failed to query blacklist."} | Query failed, e.g. search is an invalid regular expression |
| 401 | {"error":"invalid api key"} | Invalid API key — see Errors |
WARNING
Once authenticated, this endpoint always answers HTTP 200. Check the status field in the body.
TIP
search is interpreted as a regular expression — to search for numbers containing +, send "\\+66".
INFO
The list includes numbers added through every channel of your account, not only through the API.
