Update a workspace

PATCHhttps://api.vidmoat.com/v1/workspaces/{id}

Bearer tokenScope projects.writeFreeTry it in the playground

Rename, recolour, change the icon or reorder a workspace.

Path parameters#

idstringrequired
The workspace id.

Body#

namestring
Up to 48 characters.
colorstring or null
A palette colour, or null to clear it. An unknown colour also clears it.
iconstring or null
One emoji, or null to clear it.
positioninteger
Sort position, 0 to 999.

Response#

Returns 200.

Response fields#

idstring
The workspace id.
namestring
Its name.
colorstring or null
A hex colour, or null when none is set.
iconstring or null
An emoji, or null.
teamIdstring or null
The team it belongs to, or null for a personal workspace.
projectCountinteger
Projects filed in it (0 for a new one).

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
404	`not_found`	No such workspace.
400	`invalid_request`	Nothing to change, or an empty name.

curl

curl -X PATCH https://api.vidmoat.com/v1/workspaces/$ID \
  -H "Authorization: Bearer $VIDMOAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Q4"}'

Response 200

{ "id": "ws_1", "name": "Acme Q4", "color": "#5AA9FF", "icon": "🎬", "teamId": null, "projectCount": 4 }