Sign in

v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Organizations

Update an organization

Update an organization's metadata by its ID. At least one field must be provided.

Payload Requirements

  • At least one of name or description must be provided.
  • If name is provided, it must be unique within the account.
  • System-managed fields (id, created_at) cannot be modified.

Valid example

{
  "name": "Platform Engineering Team",
  "description": "Renamed from Agent Engineering Team"
}

Invalid example (no fields provided)

{}

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/organizations/{org_id}

Path parameters

org_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique organization identifier (base64)

Request body

namestring

Updated name for the organization (must be unique within the account)

descriptionstring nullable

Updated description for the organization. Set to null to clear it.

Response

An organization object

idstring required

A universally unique identifier (base64-encoded opaque string).

namestring required

Name of the organization

descriptionstring required

A brief description of the organization's purpose

created_atstring date-time required

Timestamp for when the organization was created

Example response

{
  "id": "RW50aXR5OjEyMzQ1"
}