Skip to main content
PUT
/
workspaces
/
{workspaceId}
Update Workspace
curl --request PUT \
  --url https://api.raydocs.com/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "icon": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Authentication & Scope

Requires the workspaces-write ability.

​
Request

PUT /workspaces/1 HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Updated Name",
  "icon": "📈"
}

​
Path Parameters

ParameterTypeRequiredDescription
workspaceIdintegerYesThe workspace ID

​
Body Parameters

ParameterTypeRequiredDescription
namestringNoNew name for the workspace
iconstringNoNew emoji or icon

​
Response

200 OK – The updated workspace. 
{
  "id": 1,
  "name": "Updated Name",
  "icon": "📈",
  "settings": {},
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T09:00:00Z"
}
404 Not Found – Workspace does not exist or you don’t have access.

Authorizations

​
Authorization
string
header
required

Personal Access Token created from the Raydocs dashboard. Include in the Authorization header: Bearer <your_token> See API Keys for token creation and management.

Path Parameters

​
workspaceId
integer
required

Body

application/json
​
name
string
​
icon
string

Response

Updated

​
id
integer
read-only
​
name
string
​
icon
string
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only