Create an Entry in the DNCL

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

do-not-call-lists:manage

Request Body (required)

{
  "phone_number": "+351929312312",
  "expiration_date": "2021-12-31",
  "reason": "custom request"
}

Body Response - Schema

201 (entry created)

Entry object

ParameterTypeDescriptionRequired
idstringentry IDno
do_not_call_list_idstringdo not call list IDno
phone_numberstringphone number of the recordno
reasonstringreason for the phone number is being added to do not call listno
expiration_datestringdate where the dncl entry expiresno
created_atstringrecord creation dateno
_linksobject"_links" subdivides into:

1 - "self" (object)
1.1 - "href" (string)
no

400 (errors were found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (do not call list not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!