Update details of a specific workspace

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

workspaceId*string

Unique identifier of the workspace.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional. logo / icon are NOT accepted here — use the /logo and /icon endpoints.

name?string

Lengthlength <= 100

description?string

Lengthlength <= 350

updateSlug?boolean

Determines if the slug will be regenerated or not. Meaning you could change the name but keep the old slug as it may be used in static links.

Defaultfalse

color?string

Hex colour code from the platform's approved palette (e.g. #37474F).

Value in

"#37474F"
"#FF5722"
"#2962FF"
"#33691E"
"#00796B"
"#455A64"
"#2979FF"
"#827717"
"#7986CB"
"#8E24AA"
"#9575CD"
"#BF360C"
"#01579B"
"#EF6C00"
"#AA00FF"
"#F44336"
"#7C4DFF"
"#E65100"
"#8D6E63"
"#283593"
"#607D8B"
"#009688"
"#FF5252"
"#03A9F4"
"#C2185B"
"#00ACC1"
"#E91E63"
"#5D4037"
"#78909C"
"#1E88E5"
"#D500F9"
"#7E57C2"
"#5C6BC0"
"#558B2F"
"#2E7D32"
"#F50057"
"#004D40"
"#0D47A1"
"#C51162"
"#D50000"
"#6200EA"
"#00BCD4"
"#0277BD"

Response Body

`application/json`

curl -X PUT "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "description": "string",  "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85",  "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",  "color": "string",  "settings": {},  "roles": [    "string"  ],  "status": "active",  "createdAt": 1678886400000,  "updatedAt": 1678886400000}

Update details of a specific workspace

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`