Sign in
Consent Management

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
post/v2/consent/blocklist

Parameters

#/paths/~1v2~1consent~1manage/post/parameters/0 — unresolved $ref

Request body

type'blocklist' | 'whitelist' required

Specifies whether to add or remove numbers from the blocklist.

Example request

{
  "type": "blocklist",
  "recipients": [
    {
      "recipient": "919876543210",
      "source": "WEB",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "ip": "192.168.7.26"
    }
  ]
}

Response

Indicates that blocklist or whitelist operation completed successfully.

status'success' | 'error' required

Indicates success or failure of the request.

messagestring required

Human-readable message about the response.

Example response

{
  "status": "success",
  "message": "Opt-in successfully added.",
  "data": {
    "processed_count": 1,
    "failed_recipients": [
      {
        "recipient": "919876543210",
        "error": "Invalid phone number format"
      }
    ]
  }
}

Changes