Sign in
Organization

Update an organization

Updates information for an organization.

patch/organization/{id}

Path parameters

idstring required

The ID of the organization to update.

Query parameters

metadata_includestring

Comma-separated list of metadata properties to include in the response. Available values [schemas, tags].

Request body

namestring

The name of the organization.

ℹ️ Note: Changing the organization's name does not change the slug, as doing so could break connections with existing applications and services.

status'active' | 'inactive'

The status of the organization.

Example request

{
  "name": "Crypto Inc.",
  "status": "active"
}

Response

An object representing the organization.

idinteger required

A system-wide unique ID for the organization.

namestring required

The organization name.

slugstring required

The organization slug.

status'active' | 'inactive' required

The status of the organization.

Example response

{
  "id": 9823413412,
  "name": "Crypto Inc.",
  "slug": "crypto-inc",
  "status": "active",
  "metadata": {
    "key": "value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.