1. Docs
  2. API Reference
  3. Update an organization

Update an organization

PATCH/api/v1/organizations/{id}

Updates an organization's name, description, and/or metadata by id. The slug is frozen at create and never changes. Supports optimistic concurrency via the If-Match header carrying the organization's current version (409 on a version mismatch). Requires the hierarchy.manage permission at the organization and emits organization.updated.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Headers

  • if-match required
  • 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.

Request body

application/json

namestring Optional

New organization name. The slug does not change.

descriptionstring Optional

Organization description

metadataobject Optional

Free-form metadata stored on the organization, returned as sent.

Responses

application/json

  • dataOrganizationResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

OrganizationResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/organizations/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "metadata": {}
  }'
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "metadata": {},
    "member_count": 0,
    "pending_invite_count": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
GETGet an organization
DELETEDelete an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy