Create DNC

Add a phone number to your Do Not Call (DNC) list.

When to use. Block a single number from being dialed. To approve or unapprove many numbers at once, or to create several in one call, use POST /dnc/mass.

Request body.

  • phone (string, required): the phone number to add.
  • approved (integer, required): approval status, 0 for unapproved or 1 for approved.
  • country_iso (string): the two-letter country code (for example US) used to normalize the number.
  • permanent (integer): whether the entry is permanent, 0 for no or 1 for yes. Defaults to 0 when omitted.

Returns. { "dnc": [ <entry> ] } with the created entry, and HTTP 201. Returns an error if an entry with the same phone number already exists.

Example. { "phone": "12125551234", "country_iso": "US", "approved": 1, "permanent": 0 }

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a DNC entry.

string
required

Phone number to add to the DNC list.

string

Country ISO2 code, used to normalize the phone number.

integer
required

Whether the DNC is approved: 0 = unapproved, 1 = approved.

integer

Whether the DNC is permanent: 0 = no, 1 = yes. Defaults to 0 when omitted.

Responses

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