Skip to navigation
API ReferenceRejects

List SMS denylist

Retrieves your SMS rejection denylist. You can provide a phone number to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
phonestringOptional
An optional phone number to search by in E.164 format
include_expiredbooleanOptional
Whether to include rejections that have already expired
subaccountstringOptional<=255 characters
An optional unique identifier for the subaccount to limit the denylist

Response

Success
phonestring
The phone number on the denylist
created_atstringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"
The date and time that the entry was created
expiredboolean
Whether the entry has expired
expires_atstring or nullOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"
The date and time that the entry expires
subaccountstring or nullOptional
The subaccount that the entry belongs to

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error