Sign in
Namespace

Update namespace

Update the namespace by its organization-scoped ref. Slug cannot be patched.

patch/v1/organizations/{organizationRef}/namespaces/{namespaceRef}

Request body

namestring

Name of the namespace.

descriptionstring nullable

Description of the namespace.

Example request

{
  "name": "Engineering",
  "description": "Engineering team namespace"
}

Response

OK

idstring required

Unique identifier of the namespace.

slugstring required

Organization-scoped canonical kebab-case slug. Immutable after create.

namestring required

Name of the namespace.

descriptionstring nullable

Description of the namespace.

project_countinteger nullable

Number of projects in the namespace when projected.

document_countinteger nullable

Number of documents in the namespace when projected.

created_atstring date-time required

Date when the namespace was created.

updated_atstring date-time nullable required

Date when the namespace was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "slug": "platform",
  "name": "Engineering",
  "description": "Engineering team namespace",
  "project_count": 4,
  "document_count": 8
}

Changes