Skip to main content
PUT
/
v1
/
workspaces
/
{id}
Update Workspace
curl --request PUT \
  --url https://api.vertracloud.app/v1/workspaces/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "updates": {}
}'
{
  "response": {
    "id": "org123",
    "name": "updatedworkspace",
    "description": "Updated description",
    "tags": ["newtag", "updated"],
    "owner_id": "993591427428790342",
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T20:00:00Z",
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2026-03-14T19:58:00Z"
      }
    ]
  }
}
​
id
string
required
The ID of the workspace to update.
​
updates
object
The fields to update for the workspace.

​
Response

​
response
object
The updated details of the workspace.
{
  "response": {
    "id": "org123",
    "name": "updatedworkspace",
    "description": "Updated description",
    "tags": ["newtag", "updated"],
    "owner_id": "993591427428790342",
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T20:00:00Z",
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2026-03-14T19:58:00Z"
      }
    ]
  }
}

​
Error Responses

​
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • NAME_MUST_BE_A_STRING: The provided name is not a string.
  • DESCRIPTION_MUST_BE_A_STRING: The provided description is not a string.
  • TAGS_MUST_BE_AN_ARRAY: The provided tags are not an array of strings.
  • NAME_TOO_LONG: The provided name exceeds 50 characters.
  • DESCRIPTION_TOO_LONG: The provided description exceeds 200 characters.
  • TAG_TOO_LONG: One or more tags exceed 20 characters.
  • ORGANIZATION_NAME_ALREADY_EXISTS: An workspace with the provided name already exists.
​
message
string
A descriptive message providing additional details about the error.
{
  "code": "UNAUTHORIZED"
}