Skip to main content
The internal_dnc tool manages your organization’s private Do Not Call list. Use it to add numbers when contacts request no further calls, or remove numbers when appropriate.

​
Parameters

​
phoneNumbers
string[]
required
Phone numbers in 10-digit North American format (e.g., "8663625478").
​
action
string
required
Action to perform:
  • add - Add numbers to Internal DNC list
  • remove - Remove numbers from Internal DNC list
  • status - Check if numbers are on the list
​
loginId
string
API key. Only required if not provided via the x-dncscrub-api-key HTTP header.
​
projId
string
Project ID to scope the Internal DNC list. Useful for multi-client or multi-campaign setups.

​
Response

​
success
boolean
Whether the API call succeeded.
​
results
array
Array of results for each phone number.
​
errorCode
string
Machine-readable error code (when failed).
​
errorMessage
string
Human-readable error description (when failed).

​
Error Codes

CodeDescription
MISSING_API_KEYNo API key provided in header or parameter
INVALID_API_KEYThe API key is invalid or unauthorized
API_ERRORDNCScrub API returned an error
MISSING_INPUTRequired parameters are missing
INVALID_PHONEOne or more phone numbers are invalid

​
Examples

{
  "phoneNumbers": ["5039367187", "7075276405"],
  "action": "add"
}

​
Usage Notes

  • Adding a number that already exists has no effect (idempotent)
  • Removing a number that doesn’t exist has no effect
  • Use projId to maintain separate Internal DNC lists per project or client
  • Phone numbers must be exactly 10 digits without formatting