Sign in
workspaces

Update Workspace

Changed on

Rename a workspace or change its description.

patch/api/v1/workspaces/{workspace_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

workspace_idstring uuid required

Request body

descriptionstring nullable
namestring nullable

Response

Successful Response

created_atstring date-time required
created_by_user_idstring uuid nullable
descriptionstring nullable
idstring uuid required
namestring required
organization_idstring uuid required
updated_atstring date-time nullable

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id update_workspace_api_v1_workspaces__workspace_id__patch removed and replaced with workspaces-update_workspace