Difference between revisions of "Task Delete"
Ashley DeBon (talk | contribs) (→Delete Task And Follow-ups) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-task/{task_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-task/{task_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 08:34, 20 July 2026
Mobile_API »Delete Task And Follow-ups
Base URL
https://apimobile.callproof.com
Endpoint
/api/delete-task/{task_id}
Purpose
Deletes a task (follow-up) and its related follow-up call and personnel records. If the task is linked to Google or Office calendar events, the API also attempts to remove those calendar events before deleting the task.
HTTP Method
DELETE
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | integer | Yes | Unique identifier of the task (follow-up) to delete |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-task/{task_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-task/{task_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the task was deleted successfully.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| message | string | Confirmation message (for example, "The Task has been deleted successfully") |
| task_id | integer | Identifier of the deleted task |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the task could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Invalid task ID ("Task Id is Invalid"), or another deletion error (for example, "Error while Deleting the Task").
- 401 – Authentication failed or the access token is missing/expired.