Update a workspace

Server URLloading...

PATCH

/api/v1/workspaces/{id}

Send

Authorization

Path

Header

Query

Body

Update a workspace

Partially update a given workspace.

Standard update (workspace OWNER only):

• name (string, optional): Desired workspace name (max 100 characters, cannot be empty)
• description (string, optional): Desired workspace description. Send empty string or null to clear.

Convert to a synced workspace (workspace OWNER or a role granting workspace edit/delete):

• datasource (object): Datasource configuration used to populate the workspace. Credentials are validated against the external source before persistence; use POST /api/v1/workspaces/{id}/datasource/test to validate them without committing.
• The target workspace must be empty (no documents) and not already synced.

Edit an existing synced workspace's datasource:

• If the workspace is already synced and no successful sync has happened yet, sending a datasource payload edits the datasource in place (full credential re-entry required, name/filter_criteria updated, next sync re-triggered).
• After the first successful sync, the field is rejected with 409 Conflict — ingested data integrity is preserved by locking the config. Delete and recreate the workspace to change its configuration.
• The datasource type is immutable on edit (changing it returns 400).
• Edits are also rejected with 409 while a sync is currently in flight (WAITING/PROCESSING).
• The current edit-availability is exposed in the response under sync.editable (boolean).

Restrictions:

• Only SHARED workspaces can be updated (PERSONAL workspaces cannot be modified)
• Conversion is one-way: a synced workspace cannot be reverted to manual via the API

Path Parameters

Query Parameters

Header Parameters

Response Body

curl -X PATCH "https://example.com/api/v1/workspaces/0" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 0,  "name": "string",  "workspace_type": "string",  "document_upload_method": "string",  "description": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "files_count": 0,  "user_role": "owner",  "used_storage": 0,  "summaries": [    {      "language": "string",      "summary": "string"    }  ],  "sync": {    "datasource_type": "string",    "source_name": "string",    "last_status": "string",    "updated_at": "2019-08-24T14:15:22Z",    "failed_files_count": 0,    "next_import_date": "2019-08-24T14:15:22Z",    "editable": true,    "name": "string",    "instance_url": "string",    "tenant_id": "string",    "site_name": "string",    "client_id": "string",    "filter_criteria": null  },  "scoped_api_keys": [    {      "id": "string",      "name": "string",      "prefix": "string",      "role": "string",      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "scope_type": "workspace"    }  ]}