1. Docs
  2. API Reference
  3. Update the Account name or settings

Update the Account name or settings

PATCH/api/v1/account

Updates the Account's display name and/or settings JSON; both fields are optional and only what is sent changes. settings replaces the whole object, so merge on the client to change one key. slug cannot change. Send the version you read as If-Match to refuse an update over a newer change (409, version_mismatch). Requires account.manage.

Authentication

Bearer TokenAuthorization Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission account.manageAccount

Change the Account's profile and general settings. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Headers

  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since. Leave it out to skip the check; a header that names no version (not a whole number) is refused with 400 `if_match.invalid`.

Request body

application/json

namestring Optional

Display name shown in the dashboard chrome

settingsobject Optional

Account-level configuration (branding hints, SSO settings, etc.). Replaces the full settings object — merge on the client side if you only want to change one key.

Responses

application/json

  • dataAccountResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

AccountResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/account" \
  -H "If-Match: "3"" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "settings": {}
  }'
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "settings": {},
    "plan": "string",
    "version": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "delete_grace_days": 0
  }
}
 Related endpoints
GETGet the current Account
 Was this page helpful?

Tell us how we can improve this guide.

Canopy