Client Settings

Update notification settings

Updates the saved notification settings for the authenticated client.

Supported fields are notification_email and notify_email.

notification_email may be set to null to remove the saved email address. notify_email must be a boolean.

This endpoint is available only to client API keys. The master API key cannot use client self-service settings.

patch/client/notifications

Request

Base URL
http://127.0.0.1:5000/api/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/clinicalauditai/apis/clinicalauditai-api/docs/client/notifications/patch.ts
A function with typed inputs. Its response is checked against the schema.

notification_emailstring email nullable

Email address to use for notifications. Set to null to clear it.

notify_emailboolean

Enable or disable saved email notifications.

Notification settings updated successfully

successboolean required

notification_emailstring email nullable required

notify_emailboolean required

{
  "success": true
}

No recorded changes to this operation across all 1 revision of this API.