Manage Blocklist or Whitelist

Use this API to add or remove phone numbers from the blocklist or whitelist.
Control message delivery to ensure compliance and prevent unwanted communication.

When to Blocklist:

  • Users request no communication
  • Repeated delivery failures or bounces
  • Compliance or regulatory requirements
  • Spam prevention and internal testing

When to Whitelist:

  • Re-enable blocked users
  • Prioritize VIP or testing numbers
  • Allow emergency or system notifications

Features:

  • Bulk operations supported
  • Source tracking for audit purposes
  • Integration with consent workflows
  • GDPR-compliant data handling
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Defines the payload for blocklisting or whitelisting recipients.

string
enum
required

Specifies whether to add or remove numbers from the blocklist.

Allowed:
recipients
array of objects
required
length between 1 and 1000

Lists the recipients to block or whitelist.

recipients*

Represents a single recipient’s consent or blocklist details.

string
required

Phone number of the recipient including country code (6–15 digits).

string
enum
required

Source from which the consent or blocklist request originated.

string
length ≤ 500

User agent string from the source device or application.

string

IP address from where the request originated.

Headers
string
required

Indicates the request body format. Must be application/json.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json