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

Update the admin's preferences

PATCH/portal/v1/me/preferences

Authentication

  • Bearer Token Authorization

    JWT access token

Request body

  • ui_hints_dismissedany object

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

Code samples

cURLJavaScriptPythonGo
curl -X PATCH "https://api.canopy.dev/portal/v1/me/preferences" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ui_hints_dismissed": {
      "applications_intro": true
    }
  }'

Responses

200 Merges the supplied preference values into the admin's existing preferences. `ui_hints_dismissed` is shallow-merged so dismissing one hint doesn't clobber others.
{
  "ui_hints_dismissed": {
    "applications_intro": true,
    "access_control_intro": true
  }
}

application/json

  • ui_hints_dismissedany object*

    Map of UI hint keys the user has dismissed. Keys are stable identifiers (e.g. 'applications_intro'); a hint is dismissed when its key maps to true.

401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)

Returned object

On this page

Related endpoints

GETGet the admin's preferences