Difference between revisions of "Dismiss Tasks"
Ashley DeBon (talk | contribs) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Close Task Popup == | + | == [[Mobile_API]] »Close Task Popup == |
=== Base URL === | === Base URL === | ||
| Line 33: | Line 33: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | <pre> curl --location --request PUT 'https://apimobile.callproof.com/api/close-taskpopup' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request PUT 'https://apimobile.callproof.com/api/close-taskpopup' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 08:32, 20 July 2026
Contents
Mobile_API »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.
curl --location --request PUT 'https://apimobile.callproof.com/api/close-taskpopup' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request PUT 'https://apimobile.callproof.com/api/close-taskpopup' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
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.
