Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

id
string
required

The user's ID in your database.

Body

application/json

Request body for updating user preferences.

notifications
NotificationPreferences · object

Notification preferences for each notification type.

streak
StreakPreferences · object

Per-user streak configuration. Metric and evaluation mode overrides require streak customization to be enabled in dashboard settings.

Response

Successful operation

A user's preferences.

notifications
NotificationPreferences · object
required

Notification preferences for each notification type.

streak
StreakPreferences · object

Per-user streak configuration. Metric and evaluation mode overrides require streak customization to be enabled in dashboard settings.