Skip to content
/
Update space
Last updated

Update space

Update a space's name, description, or access settings.

PATCHhttps://api.aitronos.com/v1/spaces/{space_id}

Update one or more properties of a space. Only the fields included in the request body are updated.

  • Name and description require edit access (editable_by_users, editable_by_roles, or space creator).
  • Access control fields (access_mode, access_users, access_departments, editable_by_users, editable_by_roles, visible_to_roles) require owner access (space creator or override_all_permissions capability).
  • Role and department IDs in access control fields are validated against the organization — invalid IDs return a 422 Validation Error.

Path Parameters

space_id string required

The unique identifier of the space.

Request Body

All fields are optional. Only included fields are updated.

name string optional

New space name. Must be 1–255 characters.

description string optional

New space description.

access_mode string optional

New access mode: private, organization, or public.

access_users array of strings optional

New list of user IDs with view access.

access_departments array of strings optional

New list of department IDs with view access.

editable_by_users array of strings optional

New list of user IDs with edit access.

editable_by_roles array of strings optional

New list of role IDs with edit access.

visible_to_roles array of strings optional

New list of role IDs with view access.

Returns

The updated Space object.

cURL
curl -X PATCH "https://api.aitronos.com/v1/spaces/space_abc123" \
  -H "X-API-Key: $FREDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Knowledge Base", "access_mode": "organization"}'
Previous page
Next page