Tolgee Octri Demo
PUT/v2/notification-settings

Update a notification setting

Updates a notification preference for the authenticated user. Set group to choose account security or tasks, channel to choose email or in-app delivery, and enabled to set the preference state.

3 body fields

The notification preference to update for a delivery channel and setting group.

channelstringrequired
The delivery channel: `IN_APP` or `EMAIL`.
Allowed:IN_APPEMAIL
enabledbooleanrequired
True if the setting should be enabled, false for disabled
groupstringrequired
The notification group: `ACCOUNT_SECURITY` or `TASKS`.
Allowed:ACCOUNT_SECURITYTASKS

5 status codes
200Confirms that the notification setting was saved.
400Returned when the request is invalid, including when a required field is missing or an enum value is not accepted.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when access is forbidden.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the notification setting resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

channel, enabled, and group are all required; channel must be IN_APP or EMAIL, and group must be ACCOUNT_SECURITY or TASKS. A 400 is returned for an invalid request, a 401 for an unauthenticated request, a 403 when access is forbidden, and a 404 when the setting resource is not found.