Skip to main content
PATCH
Update a space

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json

Fields are merged over the stored space — send only what you are changing. The space id comes from the path, not the body.

name
string
description
string
default_status
string
statuses
object[]
record_config_ids
string[]
default_record_config_id
string[]
priorities
object[]

Task priority definitions. Removing a priority that tasks still reference queues a background re-assignment onto the fallback priority (the default, or the first), and the update returns 202 instead of 200.

tags
object[]

Space-level tag definitions.

Whether the space has a logo set.

default_view
string

Default board/list view for the space.

staging
boolean

Marks a Space for testing so it can be reset. Only root and admin users can set it.

Shows the Related tickets section on tasks in this space and lets them link to others.

allow_linking
boolean

Opens the space to links with other accounts.

task_automations
object[]

Rules that act on tasks left in given statuses for a number of days.

view
object

Presentation settings: tasks, records (including saved_views), front_page (including layouts), dashboard, entities, assistant_skills.

base_record
object

The record config and identity fields that define the space's client or organisation entity.

hidden_tabs
string[]

Built-in tabs the space does not offer.

assigned_qa_users
string[]

Users offered as a task's assigned_qa. Empty hides the field.

task_export_fields
object[]

Columns of a task export, in order.

custom_tab
object

The space's own tab of buttons.

Response

Updated space

id
string
read-only
url
string
read-only

UI URL to navigate directly to this space

name
string
description
string
default_status
string
statuses
object[]
owner
string
read-only

ID of the user who created the space, set by the backend

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only
record_config_ids
string[]
default_record_config_id
string[]
priorities
object[]
tags
object[]
staging
boolean

Marks a space for testing. Only root and admin users can set it. Staging spaces can be reset.

distribution_bindings
object[]
read-only

Connections to other accounts. Present on a space connected through distribution.

Shows the Related tickets section on tasks in this space and lets them link to others.

allow_linking
boolean

Opens the space to links with other accounts.

task_automations
object[]

Rules that act on tasks left in given statuses for a number of days.

view
object

Presentation settings: tasks, records (including saved_views), front_page (including layouts), dashboard, entities, assistant_skills.

base_record
object

The record config and identity fields that define the space's client or organisation entity.

custom_tab
object

The space's own tab of buttons.

hidden_tabs
string[]

Built-in tabs the space does not offer.

assigned_qa_users
string[]

Users offered as a task's assigned_qa. Empty hides the field.

task_export_fields
object[]

Columns of a task export, in order.

logo_key
string
read-only

Key of a logo in the public profile-images bucket, set when the space was built from a template. Create-only.

template
object
read-only

Stamp left by the template the space was installed from. Kept as sent and read only by the platform.

editing_disabled
boolean
read-only

When true the space is locked: update and delete are refused. Create-only, with no unlock.