---
title: "Manage Blocklist or Whitelist"
method: POST
path: "/v2/consent/blocklist"
tags: ["Consent Management"]
---

# Manage Blocklist or Whitelist

`POST /v2/consent/blocklist`

## Request

- Base URL: `https://cpaaswa.netcorecloud.net/api`
- URL: `https://cpaaswa.netcorecloud.net/api/v2/consent/blocklist`
- Auth: HTTP bearer

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

## Parameters

- `#/paths/~1v2~1consent~1manage/post/parameters/0` (unresolved $ref)

## Request body

- BlocklistManagementRequest: Defines the payload for blocklisting or whitelisting recipients.
  - `type` 'blocklist' | 'whitelist', required: Specifies whether to add or remove numbers from the blocklist.
  - `recipients` ConsentRecipient[], required: Lists the recipients to block or whitelist.
    - `recipient` string, required: Phone number of the recipient including country code (6–15 digits).
    - `source` 'WEB' | 'MOBILE_APP' | 'SMS_CAMPAIGN' | 'IVR' | 'EMAIL' | 'RETAIL' | 'CONTACT_CENTER' | 'WHATSAPP_SESSION' | 'API' | 'ADMIN_PANEL' | 'USER_REQUEST' | 'COMPLIANCE' | 'GDPR_REQUEST' | 'SPAM_DETECTION' | 'REGULATORY_COMPLIANCE' | 'TESTING' | 'DEVELOPMENT' | 'OTHER', required: Source from which the consent or blocklist request originated.
    - `user_agent` string: User agent string from the source device or application.
    - `ip` string, ipv4: IP address from where the request originated.

## Response `200`

Indicates that blocklist or whitelist operation completed successfully.

- ConsentResponse: Represents the standard success response for consent or blocklist actions.
  - `status` 'success' | 'error', required: Indicates success or failure of the request.
  - `message` string, required: Human-readable message about the response.
  - `data` object: Contains operation result details.
    - `processed_count` integer: Number of recipients successfully processed.
    - `failed_count` integer: Number of recipients that failed processing.
    - `failed_recipients` object[]: List of recipients that failed processing.
      - `recipient` string
      - `error` string

## Other responses

- `400` (unresolved $ref)
- `401` (unresolved $ref)
- `403` (unresolved $ref)
- `500` (unresolved $ref)

---

[API](https://skmtc.dev/netcorecloud/apis/whatsapp-api.md) - [All operations](https://skmtc.dev/netcorecloud/apis/whatsapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/netcorecloud/apis/whatsapp-api/revisions/82cdf689fb7a?raw)