post https://api.talkdeskapp.com/do-not-call-lists//entries
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
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | entry ID | no |
| do_not_call_list_id | string | do not call list ID | no |
| phone_number | string | phone number of the record | no |
| reason | string | reason for the phone number is being added to do not call list | no |
| expiration_date | string | date where the dncl entry expires | no |
| created_at | string | record creation date | no |
| _links | object | "_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)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[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.