Difference between revisions of "Settings to Put Current user Preference Configuration"
Ashley DeBon (talk | contribs) (Created page with "== Update App Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/app-settings === Purpose === Updates the authenticated user’s mobile app...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Update App Settings == | + | == [[Mobile_API]] »Update App Settings == |
=== Base URL === | === Base URL === | ||
| Line 45: | Line 45: | ||
| task_notification_time_id || integer || Yes || Selected task notification timing choice ID | | task_notification_time_id || integer || Yes || Selected task notification timing choice ID | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location --request PUT 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "sync_task_on_device_calender": true, "hide_mobile_appointment_popup": false, "task_popup_setting": true, "is_contact_page_as_homepage": false, "task_notification_time_id": 1 }' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request PUT 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "sync_task_on_device_calender": true, "hide_mobile_appointment_popup": false, "task_popup_setting": true, "is_contact_page_as_homepage": false, "task_notification_time_id": 1 }' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:36, 20 July 2026
Contents
Mobile_API »Update App Settings
Base URL
https://apimobile.callproof.com
Endpoint
/api/app-settings
Purpose
Updates the authenticated user’s mobile app preference settings, including appointment popup visibility, task popup preference, contacts-as-homepage preference, and task notification timing.
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
| Parameter | Type | Required | Description |
|---|---|---|---|
| sync_task_on_device_calender | boolean | Yes | Device calendar sync preference (accepted/validated by the API) |
| hide_mobile_appointment_popup | boolean | Yes | Whether to hide the mobile appointment popup |
| task_popup_setting | boolean | Yes | Whether the task popup should be shown (true = show popup)
|
| is_contact_page_as_homepage | boolean | Yes | Whether the contacts page should be the app homepage |
| task_notification_time_id | integer | Yes | Selected task notification timing choice ID |
cURL Example for Android
curl --location --request PUT 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "sync_task_on_device_calender": true, "hide_mobile_appointment_popup": false, "task_popup_setting": true, "is_contact_page_as_homepage": false, "task_notification_time_id": 1 }'
cURL Example for iOS
curl --location --request PUT 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "sync_task_on_device_calender": true, "hide_mobile_appointment_popup": false, "task_popup_setting": true, "is_contact_page_as_homepage": false, "task_notification_time_id": 1 }'
Successful Response (200)
Indicates that the app settings 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, "Settings Updated Successfully") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200/401 | Validation failed – response body uses clientStatusCode 401 with the first validation error message
|
| 400 | Bad Request – settings could not be updated |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Validation (clientStatusCode 401) – Missing or invalid boolean/numeric values for required settings fields.
- 400 – An error occurred while updating settings (for example, "Error while Updating").
- 401 – Authentication failed or the access token is missing/expired.
