---
title: "Update preferences for the authenticated user"
method: PATCH
path: "/api/v3/user/preferences"
tags: ["Users"]
---

# Update preferences for the authenticated user

`PATCH /api/v3/user/preferences`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/user/preferences`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/user/preferences/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- UpdatePreferencesSchema
  - `selected_team` string
  - `theme` 'light' | 'dark' | 'system'
  - `expanded_nav` boolean
  - `eligible_for_onboarding_flow` boolean: Whether the onboarding flow is shown to the user.
  - `pinned_apps` PinnedAppsSchema[]: Each listed team's pinned apps are replaced. Apps that are missing or not accessible to the user are ignored.
    - `team_id` string, required
    - `app_ids` string[], required

## Response `204`

Request fulfilled, nothing follows

## Other responses

- `400`: The request could not be validated
- `401`: Authentication is missing or invalid
- `429`: The rate limit has been exceeded

---

[API](https://skmtc.dev/codemagic/apis/codemagic-api.md) - [All operations](https://skmtc.dev/codemagic/apis/codemagic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/codemagic/apis/codemagic-api/revisions/be09630f65e2?raw)
