1. Docs
  2. API Reference
  3. Update the admin's preferences

Update the admin's preferences

PATCH/portal/v1/me/preferences

Applies a partial update to the calling admin's preferences. Omitted fields are left untouched; the keys sent in ui_hints_dismissed are shallow-merged onto the stored map (JSONB ||), so dismissing one hint preserves previously dismissed keys. Returns the full post-patch preferences so the client can replace its cache without a follow-up read.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Request body

application/json

ui_hints_dismissedobject Optional

Partial map of UI hint keys → true. Existing dismissed keys are preserved; only the keys provided here are added.

Responses

application/json

  • dataUserPreferencesResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

UserPreferencesResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/me/preferences" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ui_hints_dismissed": {
      "applications_intro": true
    }
  }'
Response
{
  "data": {
    "ui_hints_dismissed": {
      "applications_intro": true,
      "access_control_intro": true
    }
  }
}
 Related endpoints
GETGet the admin's preferences
 Was this page helpful?

Tell us how we can improve this guide.

Canopy