Skip to content

Update the user's preferences​

PATCH
/api/user/preferences

Send only the fields to change. Changing week_start closes, before
the response is returned, any weekly quota period the new boundary has
already ended (see UserPreferences.week_start).

Authorizations​

bearerAuth

API token created via POST /api/tokens or the db:create-token CLI command

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
"default_grouping": "string",
"project_preview_count": 6,
"auto_snooze_minutes": 30,
"auto_snooze_low_minutes": 240,
"auto_snooze_medium_minutes": 60,
"auto_snooze_high_minutes": 15,
"auto_snooze_urgent_minutes": 5,
"default_reminder_slot_id": 0,
"quota_prompt_slot_id": 0,
"quota_prompts_enabled": true,
"enrichment_notifications_enabled": true,
"sweep_feedback_notifications_enabled": true,
"week_start": "sunday",
"check_in_day": 6,
"default_snooze_option": "60",
"ai_context": "string",
"ai_context_updated_at": "string",
"additionalProperties": "string"
}

Responses​

The user's preferences after the update

application/json
JSON
{
"data": {
"default_grouping": "string",
"project_preview_count": 6,
"auto_snooze_minutes": 30,
"auto_snooze_low_minutes": 240,
"auto_snooze_medium_minutes": 60,
"auto_snooze_high_minutes": 15,
"auto_snooze_urgent_minutes": 5,
"default_reminder_slot_id": 0,
"quota_prompt_slot_id": 0,
"quota_prompts_enabled": true,
"enrichment_notifications_enabled": true,
"sweep_feedback_notifications_enabled": true,
"week_start": "sunday",
"check_in_day": 6,
"default_snooze_option": "60",
"ai_context": "string",
"ai_context_updated_at": "string",
"additionalProperties": "string"
}
}

Samples​

Powered by VitePress OpenAPI