Trillet AI logo

Update Workspace Name

Rename a workspace, or change its display currency.

PUThttps://api.trillet.ai/v1/api/workspaces/{workspaceId}

Your role needs the workspace:edit permission. For a client workspace under an agency or Studio master, you also need agency_hub:edit on the master workspace.

Send either name or displayCurrency. If displayCurrency is present, only the currency is updated and name is ignored.

Path Parameters

workspaceIdstringrequired

The _id of the workspace to update.

Headers

x-workspace-idstringrequired

A workspace where your role has workspace:edit. Permissions are checked against this header, so it's normally the same workspace as workspaceId.

Request Body

namestring

The new name for the workspace. Leaving out both fields returns 200 with nothing changed.

displayCurrencystring

The currency code to display amounts in, for example usd or aud. Stored in lowercase.

Response

The full updated workspace object (the same shape as Get Workspace by ID), including:

_idstring

The workspace ID.

namestring

The workspace name.

initialsstring

The workspace initials.

teamMembersarray

The workspace's team members.

createdAtstring

When the workspace was created (ISO 8601).

updatedAtstring

When the workspace was last updated (ISO 8601).

Errors

StatusBodyWhen
403{"error": "Insufficient permissions", ...}Your role lacks workspace:edit
403{"error": "Insufficient permissions to update workspace"}Client workspace and you lack agency_hub:edit on the master
404{"error": "Workspace not found"}No workspace with that ID that you can see
500{"error": "..."}Unexpected server error
{
  "name": "Sales Team"
}

Last updated on