Skip to main content
PUT
Update Reminder Preferences

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

Request model for updating reminder preferences.

enabled
boolean | null

Master toggle for all reminders

onboarding_nudges
boolean | null

Enable/disable onboarding nudges

engagement_reminders
boolean | null

Enable/disable engagement reminders

feature_tips
boolean | null

Enable/disable feature tips

quiet_hours_start
integer | null

Hour (0-23) to start quiet period (UTC)

quiet_hours_end
integer | null

Hour (0-23) to end quiet period (UTC)

Response

Successful Response

Response model for reminder preferences.

reminders
ReminderPreferences · object
required

Reminder/nudge email preferences