Update Workspace

PUT 
/organizations/:org_id/workspaces/:workspace_id

Update Workspace

Request

Path Parameters

org_id Org Idrequired
workspace_id Workspace Idrequired

application/json

Body

required

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

updated_atobject

anyOf

MOD1

string

Responses

200

Successful Response

application/json

Schema

Schema

created_at Created At (string)

Default value: 2025-05-15 07:35:40.094202+00:00

updated_at Updated At (string)

Default value: 2025-05-15 07:35:40.094271+00:00

id Id (string)required
name Name (string)required
descriptionobject

anyOf

MOD1

string

typeobject

required

anyOf

MOD1

string

organization Organization (string)required
membersobject

anyOf

MOD1

Array [

user

object

required

property name* any

roles

object[]

required

Array [

role_name WorkspaceRole (string)required

Possible values: [owner, viewer, editor, evaluator, workspace_admin, deployment_manager]

role_description

object

anyOf

MOD1

string

permissions

object

anyOf

MOD1

Array [

string

Possible values: [read_system, view_application, edit_application, create_application, delete_application, create_app_variant, delete_app_variant, modify_variant_configurations, delete_application_variant, run_service, create_secret, view_secret, update_secret, delete_secret, view_app_environment_deployment, edit_app_environment_deployment, create_app_environment_deployment, view_testset, edit_testset, create_testset, delete_testset, view_evaluation, run_evaluations, edit_evaluation, create_evaluation, delete_evaluation, deploy_application, view_workspace, edit_workspace, create_workspace, delete_workspace, modify_user_roles, add_new_user_to_workspace, edit_organization, delete_organization, add_new_user_to_organization, reset_password, view_billing, edit_billing, view_workflows, edit_workflows, view_evaluators, edit_evaluators, view_testsets, edit_testsets, view_annotations, edit_annotations, delete_annotations]

]

]

]

Example (from schema)

{
  "created_at": "2025-05-15 07:35:40.094202+00:00",
  "updated_at": "2025-05-15 07:35:40.094271+00:00",
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "organization": "string",
  "members": [
    null
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...