Update Workspace Name
Rename a workspace, or change its display currency.
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
workspaceIdstringrequiredThe _id of the workspace to update.
Headers
x-workspace-idstringrequiredA workspace where your role has workspace:edit. Permissions are checked against this header, so it's normally the same workspace as workspaceId.
Request Body
namestringThe new name for the workspace. Leaving out both fields returns 200 with nothing changed.
displayCurrencystringThe 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:
_idstringThe workspace ID.
namestringThe workspace name.
initialsstringThe workspace initials.
teamMembersarrayThe workspace's team members.
createdAtstringWhen the workspace was created (ISO 8601).
updatedAtstringWhen the workspace was last updated (ISO 8601).
Errors
| Status | Body | When |
|---|---|---|
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