ROrossum
Workspace

Update workspace

Changed on

Update workspace object.

put/api/v1/workspaces/{workspaceID}

Request

Request body

idinteger

ID of the workspace

namestring

Name of the workspace

urlstring uri

URL of the workspace

autopilotboolean

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organizationstring uri

Organization URL.

queuesstring[]

List of queues that belongs to the workspace

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

created_bystring uri nullable

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_atstring date-time nullable

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

OK

idinteger required

ID of the workspace

namestring required

Name of the workspace

urlstring uri required

URL of the workspace

autopilotboolean required

Whether to automatically confirm datapoints from previously seen annotations.

Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace.

organizationstring uri required

Organization URL.

queuesstring[] required

List of queues that belongs to the workspace

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

created_bystring uri nullable required

URL of the workspace creator. Might be null for workspaces created before April 2026.

created_atstring date-time nullable required

Date of workspace creation. Might be null for workspaces created before April 2026.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 7540,
  "name": "East West Trading Co",
  "url": "https://example.rossum.app/api/v1/workspaces/7540",
  "autopilot": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "metadata": {
    "some_key": "some_value"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status