Enables the ability to remove entries from Campaign-specific and Global Do Not Call (DNC) Lists.
Endpoint:
POST https://api.convoso.com/v1/dnc/delete
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | authorization token |
| phone_number | string | Yes | Filter by the phone number (digits only, no formatting). |
| phone_code | string | Yes | Country Code. Example: "1" for US/Canada. |
| campaign_id | string | Yes | Campaign ID for campaign-specific DNC List, 0 for global. |
| update_lead_status | string | No | Update Lead Status |
| lead_status | string | No | Lead Status |
⚠️ Error Codes
| Code | Message |
|---|---|
6000 | Missing Phone Code |
6001 | Missing Campaign ID |
6002 | Missing Phone Number |
6003 | Phone Number Not Found |
6004 | Invalid Lead Status |
6005 | Missing Lead Status |
Example Request
POST https://api.convoso.com/v1/dnc/delete?auth_token=YOUR_AUTH_TOKEN&phone_number=9999999999&phone_code=1&campaign_id=0&update_lead_status=no&lead_status=
Response Format (JSON)
{
"success": true
}Response Field Definitions
Response Top-Level Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if request was successful. |