Account

Update the account settings

PATCH/account/settings
account:writeupdate_account_settingsIdempotent

Changes the calling user's own settings and returns them. display_multi_account_modal must be a boolean: a string or number is 422. dry_run shows the result without saving. Sends no email and emits no webhook. Sending the previous value undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · AccountSettingsUpdate

  • display_multi_account_modalboolean#

    Whether the app shows the account picker to a user who belongs to more than one account. It must be a boolean.

{
  "display_multi_account_modal": true
}

Responses

200

The account settings after the change.

AccountSettings
{
  "data": {
    "display_multi_account_modal": true
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/account/settings\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "display_multi_account_modal": true
}'