Sign in
Space

Update the space

Renames the space. The subdomain cannot be changed through the API.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

put/api/space

Request body

namestring required

The new name of the space. Must not be blank.

Example request

{
  "name": "Acme Production"
}

Response

The request has succeeded.

type'space' required

The object type. Always space.

idstring uuid required

Universal Unique Identifier.

namestring required

The name of the space.

subdomainstring required

The subdomain of the space, which is the first label of its URL.

verifiedboolean required

Whether the space has completed verification. An unverified space cannot use this API.

trialboolean required

Whether the space is on a trial.

created_atstring date-time required

The date and time when the space was created.

updated_atstring date-time required

The date and time when the space was last updated.

Example response

{
  "type": "space",
  "name": "Acme Space",
  "subdomain": "acme",
  "verified": true,
  "created_at": "2026-01-15T00:00:00Z",
  "updated_at": "2026-08-20T14:19:00Z"
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.