Difference between revisions of "Task Delete"
Ashley DeBon (talk | contribs) (Created page with "== Delete Task And Follow-ups == === Base URL === https://apimobile.callproof.com === Endpoint === /api/delete-task/{task_id} === Purpose === Deletes a task (follow-up) and...") |
Ashley DeBon (talk | contribs) (→Delete Task And Follow-ups) |
||
| Line 1: | Line 1: | ||
| − | == Delete Task And Follow-ups == | + | == [[Mobile_API]] »Delete Task And Follow-ups == |
=== Base URL === | === Base URL === | ||
Revision as of 08:33, 20 July 2026
Contents
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.
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.
