Canceling a Report Job Request

❗️

The Reporting API has been replaced by the Explore API. Talkdesk strongly encourages the transition to the Explore API. You may still use the Reporting API, but please note:

  • Talkdesk will only provide support (no SLA for bug fixing or outage recovery) until June 1, 2022.
  • The Reporting API endpoint will stop responding to requests on December 1, 2022.

Request

Make a DELETE request to /reports/<report_type>/jobs/{id}

❗️

The DELETE /reports/<report_type>/jobs/{id} endpoint has been deprecated.

🚧

After a report job has been requested, it is possible to cancel it by making an authenticated request to the job's endpoint and by using the DELETE method.

Sample Request

curl https://api.talkdeskapp.com/reports/calls/jobs/{id} \
-H 'Authorization: Bearer {ACESS_TOKEN}' \
-X DELETE

Response

  • If the report is not yet created, the job will be successfully canceled, and the endpoint will return a 200 response.

  • If the job is already finished and the report has been created, a 403 response will be returned.


Did this page help you?