Difference between revisions of "Dismiss Tasks"
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
Ashley DeBon (talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | == | + | == Close Task Popup == |
=== Base URL === | === Base URL === | ||
| Line 5: | Line 5: | ||
=== Endpoint === | === Endpoint === | ||
| − | /api/ | + | /api/close-taskpopup |
=== Purpose === | === Purpose === | ||
| − | + | Dismisses the current-tasks popup for the authenticated user for the day by turning off the user’s “show task popup” flag. | |
=== HTTP Method === | === HTTP Method === | ||
| Line 32: | Line 32: | ||
==== Request Body ==== | ==== Request Body ==== | ||
| − | + | None. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Successful Response (200) === | === Successful Response (200) === | ||
| − | Indicates that the task | + | Indicates that the task popup was dismissed successfully. |
{| class="wikitable" | {| class="wikitable" | ||
| Line 67: | Line 46: | ||
| company_id || integer || Identifier of the authenticated user’s company | | company_id || integer || Identifier of the authenticated user’s company | ||
|- | |- | ||
| − | | message || string || Confirmation message (for example, "Tasks | + | | message || string || Confirmation message (for example, "Tasks dismissed for the day.") |
|- | |- | ||
| uri || string || Requested resource URI | | uri || string || Requested resource URI | ||
| Line 76: | Line 55: | ||
! Status Code !! Meaning | ! Status Code !! Meaning | ||
|- | |- | ||
| − | + | | 400 || Bad Request – the task popup could not be dismissed | |
| − | |||
| − | | 400 || Bad Request – task | ||
|- | |- | ||
| 401 || Unauthorized – missing, invalid, or expired Bearer token | | 401 || Unauthorized – missing, invalid, or expired Bearer token | ||
|} | |} | ||
| − | + | * '''400''' – An error occurred while dismissing the popup (for example, "Error while Dismiss the task details"). | |
| − | * '''400''' – | ||
* '''401''' – Authentication failed or the access token is missing/expired. | * '''401''' – Authentication failed or the access token is missing/expired. | ||
Revision as of 08:30, 20 July 2026
Contents
Close Task Popup
Base URL
https://apimobile.callproof.com
Endpoint
/api/close-taskpopup
Purpose
Dismisses the current-tasks popup for the authenticated user for the day by turning off the user’s “show task popup” flag.
HTTP Method
PUT
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
Successful Response (200)
Indicates that the task popup was dismissed 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, "Tasks dismissed for the day.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the task popup could not be dismissed |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while dismissing the popup (for example, "Error while Dismiss the task details").
- 401 – Authentication failed or the access token is missing/expired.
