Update User Notification Settings - Revision history

Ashley DeBon: /* Successful Response (200) */

2026-07-21T13:53:39Z

‎Successful Response (200)

Ashley DeBon: /* Update User Notification Settings */

2026-07-21T13:53:09Z

‎Update User Notification Settings

Ashley DeBon: Created page with "== Update User Notification Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/update-user-notification-settings === Purpose === Updates one..."

2026-07-21T13:53:00Z

Created page with "== Update User Notification Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/update-user-notification-settings === Purpose === Updates one..."

New page

== Update User Notification Settings ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/update-user-notification-settings

=== Purpose ===
Updates one notification preference for the authenticated user. For most notification types this enables/disables the setting. For <code>device_notification</code>, it updates the selected task notification timing choice.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| type_key || string || Yes || Notification setting key to update. Supported values: <code>video_message_notification</code>, <code>video_message_email_notification</code>, <code>callproof_academy_notification</code>, <code>allow_outside_video_messages</code>, <code>device_notification</code>
|-
| value || string/boolean/integer || Yes || New value for the setting. For most types this is an enabled/disabled flag. For <code>device_notification</code>, this is the selected task notification timing choice ID
|}

=== Successful Response (200) ===
Indicates that the notification setting was updated successfully.

{| class="wikitable"
! 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, "User notification settings updated successfully")
|-
| notification_type || string || The <code>type_key</code> that was updated
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – the notification setting could not be updated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>type_key</code> or <code>value</code>.
* '''400''' – An error occurred while updating the setting (for example, "Error while updating the user notification settings").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:53, 21 July 2026
Line 1:		Line 1:
−	== Update User Notification Settings ==	+	== [[Mobile_API]] »Update User Notification Settings ==

	=== Base URL ===		=== Base URL ===

@@ Line 39: / Line 39: @@
 | value || string/boolean/integer || Yes || New value for the setting. For most types this is an enabled/disabled flag. For <code>device_notification</code>, this is the selected task notification timing choice ID
 |}
 === Successful Response (200) ===