delete https://api.talkdeskapp.com/do-not-call-lists//entries
Update a DNCL by adding or deleting an entry on a DNCL
Scope
do-not-call-lists:manage
Request Body (required)
[
{
"id": "8858c834-481d-4a02-8176-cffc02c50350"
},
{
"id": "f03004be-2853-4660-b6e8-060cc383ddbe"
}
]
Body Response - Schema
200 (get a list of entries - bulk deleted entries response samples)
Parameter | Type | Description | Required |
---|---|---|---|
id | string | The ID of DNCL. >= 1 characters | yes |
has_errors | boolean | true if entries deleted has errors | yes |
total_errors | integer | The number of the total errors. >= 0 <= 100 | yes |
total_deleted | integer | The total number of deleted. >= 0 <= 100 | yes |
_links | object | HAL API related links. "_links" subdivides into: 1 - "self" (object) - the records page link. Required. 1.1 - "href" (string) 2 - "record_list" (object) - the DNCL page link. 2.1 - "href" (string) | no |
_embedded | object | "_embedded" subdivides into: 1 - "failed_records" (array[object]) - the number of records that failed to delete. Required. 1.1 - "id" (string) - entry ID. Required. 1.2 - "_links" (object) 1.2.1 - "self" (object) 1.2.1.1 - "href" (string) | yes |
400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (entry 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.