v1

latestOpenAPI 3.1.0Any Source Available License 1.02026-07-1736102200.0 KB
Spaces

Update space

Updates the name or description of an existing space. The request body should contain the new name and/or description in JSON format. This endpoint is useful for renaming or rebranding a workspace without needing to recreate it. The updated space’s metadata is returned in the response.

patch/v1/spaces/{space_id}

Path parameters

space_idstring required

The ID of the space to update; must be retrieved from ListSpaces endpoint

Headers

Anytype-Versionstring required

The version of the API to use

Request body

descriptionstring

The description of the space

namestring

The name of the space

Example request

{
  "description": "The local-first wiki",
  "name": "New Space"
}

Response

The updated space

Example response

{
  "space": {
    "description": "The local-first wiki",
    "gateway_url": "http://127.0.0.1:31006",
    "icon": {
      "emoji": "📄"
    },
    "id": "bafyreigyfkt6rbv24sbv5aq2hko3bhmv5xxlf22b4bypdu6j7hnphm3psq.23me69r569oi1",
    "name": "My Space",
    "network_id": "N83gJpVd9MuNRZAuJLZ7LiMntTThhPc6DtzWWVjb1M3PouVU",
    "object": "space"
  }
}