v1

latestOpenAPI 3.0.32026-07-17542197.8 KB

Organization

Update organization

Update the organization by its ID.

patch/v1/organizations/{id}

Request body

namestring

Name of the organization.

emailstring email

Email address of the organization.

logostring uri nullable

Logo of the organization.

websitestring uri nullable

Work title of the user.

status'active' | 'deleted'

Status of the organization.

Example request

{
  "name": "ACME Inc.",
  "email": "info@example.com",
  "logo": "https://example.com/static/logo.png",
  "website": "https://example.com",
  "status": "active"
}

Response

idstring required

Unique identifier of the organization.

namestring required

Name of the organization.

emailstring email required

Email address of the organization.

logostring uri nullable required

Logo of the organization.

websitestring uri nullable required

Work title of the user.

status'active' | 'deleted' required

Status of the organization.

membersstring[] required

IDs of the users in the organization.

teamsstring[] required

IDs of the teams in the organization.

namespacesstring[] required

IDs of the namespaces in the organization.

created_atstring date-time required

Date when the organization was created.

updated_atstring date-time nullable required

Date when the organization was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "name": "ACME Inc.",
  "email": "info@example.com",
  "logo": "https://example.com/static/logo.png",
  "website": "https://example.com",
  "status": "active",
  "members": [
    "9bsv0s46s6s002p9ltq0"
  ],
  "teams": [
    "9bsv0s46s6s002p9ltq0"
  ],
  "namespaces": [
    "9bsv0s46s6s002p9ltq0"
  ]
}