Difference between revisions of "User ToolTip Updations"
Ashley DeBon (talk | contribs) (→Update User Tooltip) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 50: | Line 50: | ||
| home_settings_screen || boolean || No || Tooltip seen/completed flag for the home settings screen | | home_settings_screen || boolean || No || Tooltip seen/completed flag for the home settings screen | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/update-usertooltip' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "no_more_tips": "", "has_tooltip_enable": true, "home_screen": true, "accounts_screen": true, "route_screen": true, "places_screen": true, "places_filter_screen": true, "home_settings_screen": true }' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/update-usertooltip' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "no_more_tips": "", "has_tooltip_enable": true, "home_screen": true, "accounts_screen": true, "route_screen": true, "places_screen": true, "places_filter_screen": true, "home_settings_screen": true }' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Revision as of 09:23, 21 July 2026
Contents
Update User Tooltip
Base URL
Endpoint
/api/update-usertooltip
Purpose
Updates the authenticated user’s in-app tooltip preferences for various screens. You can update individual screen tip flags, or clear all tips when no_more_tips is set to disable further tips.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| no_more_tips | boolean/string | No | When set to the string false, clears all tooltip screen flags (sets them to false). Otherwise, only the provided screen fields below are updated
|
| has_tooltip_enable | boolean | No | Whether tooltips are enabled overall |
| home_screen | boolean | No | Tooltip seen/completed flag for the home screen |
| accounts_screen | boolean | No | Tooltip seen/completed flag for the accounts screen |
| route_screen | boolean | No | Tooltip seen/completed flag for the routes screen |
| places_screen | boolean | No | Tooltip seen/completed flag for the places screen |
| places_filter_screen | boolean | No | Tooltip seen/completed flag for the places filter screen |
| home_settings_screen | boolean | No | Tooltip seen/completed flag for the home settings screen |
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/update-usertooltip' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "no_more_tips": "", "has_tooltip_enable": true, "home_screen": true, "accounts_screen": true, "route_screen": true, "places_screen": true, "places_filter_screen": true, "home_settings_screen": true }'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/update-usertooltip' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "no_more_tips": "", "has_tooltip_enable": true, "home_screen": true, "accounts_screen": true, "route_screen": true, "places_screen": true, "places_filter_screen": true, "home_settings_screen": true }'
Successful Response (200)
Indicates that tooltip preferences were updated 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, "ToolTip preference was Successfully updated") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – tooltip preferences could not be updated |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while updating tooltip preferences (for example, "Error while Updating Tool Tip preference").
- 401 – Authentication failed or the access token is missing/expired.
