Organization

Update organization

Changed on

Update the organization by its ID.

patch/v1/organizations/{organizationRef}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization)

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

OK

idstring required

Unique identifier of the organization.

slugstring required

Globally unique canonical kebab-case slug. Immutable after create.

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.

member_countinteger nullable

Number of members in the organization when projected.

document_countinteger nullable

Number of documents that belong to the organization when projected.

team_countinteger nullable

Number of teams in the organization when projected.

namespace_countinteger nullable

Number of namespaces in the organization when projected.

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",
  "slug": "acme",
  "name": "ACME Inc.",
  "email": "info@example.com",
  "logo": "https://example.com/static/logo.png",
  "website": "https://example.com",
  "status": "active",
  "member_count": 12,
  "document_count": 4,
  "team_count": 3,
  "namespace_count": 2
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status