---
title: "Update workspace"
method: POST
path: "/documents/workspaces-update"
tags: ["Document AI — DMS"]
---

# Update workspace

`POST /documents/workspaces-update`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/workspaces-update`
- Auth: HTTP bearer

po_workspaces_update: Update workspace fields (name, business type, tier, AI-DMS, IDP pipeline, access protection, contacts, storage, document-type preset). workspace_tier changes affect trash/recycle-bin behaviour for new deletes (see...

## Request body

- object
  - `id` integer, required: Workspace ID from workspaces-list (canonical).
  - `name` string: New workspace name.
  - `description` string: New description.
  - `workspace_tier` 'standard' | 'confidential' | 'compliance': Security tier (only Upgrade erlaubt, no Downgrade).
  - `is_revision_secure` boolean: Enable revision-safe mode (one-time, irreversible).
  - `retention_years` integer: Retention period in years. Increase allowed only for WORM only.
  - `ai_dms_mode` 'disabled' | 'basic' | 'premium' | 'ultra': AI-DMS processing mode for the workspace. When changed, existing documents may be reprocessed according to the new mode.
  - `default_locale` string: Default language/region.
  - `workspace_password` string: New workspace password.
  - `status` string: Workspace-Status.
  - `type` string: Business workspace type (optional on update).
  - `image` string: Image URL.
  - `priority` integer: LEGACY queue weight (numeric). Prefer processing_lane (Start-SLA). If processing_lane is set, the lane wins. Do not use as the public SLA product. For workspaces: legacy plan-gated weight 100–999 — not Start-SLA; use default_processing_lane.
  - `is_default` boolean: Mark as standard.
  - `is_stealth` boolean: Stealth-Modus.
  - `is_archived` boolean: Archiviert.
  - `color` string: Color code.
  - `icon` string: Workspace icon key or emoji shown in the UI.
  - `tags` string[]: Comma-separated workspace tags for filtering.
  - `contact_salutation` string: Contact salutation (e.g. Mr, Ms, Dr).
  - `contact_firstname` string: Contact given name for workspace metadata.
  - `contact_lastname` string: Contact family name for workspace metadata.
  - `contact_email` string: Contact email address for workspace metadata.
  - `contact_phone` string: Contact phone number (E.164 recommended).
  - `company_name` string: Company or organization name.
  - `address_street` string: Street address line.
  - `address_zip` string: Postal or ZIP code.
  - `address_city` string: City name.
  - `address_country` string: Country ISO 3166-1 alpha-2 code.
  - `metadata` object: Additional metadata
  - `password_enabled` boolean: Enable or disable password protection.
  - `sms_enabled` boolean: SMS-Verifizierung enable.
  - `sms_phone` string: Phone number for SMS verification.
  - `dual_auth_enabled` boolean: 2-persons-approval enable.
  - `dual_auth_phone_1` string: Phone number Person 1.
  - `dual_auth_phone_2` string: Phone number Person 2.
  - `workspace_id` integer: Alias for `id` (same numeric workspace ID).
  - `default_processing_lane` 'no_sla' | 'sla_24h' | 'sla_12h' | 'sla_6h' | 'sla_1h' | 'instant': Workspace default Start-SLA. Used when Auto AI-DMS omits processing_lane. Alias: processing_lane.
  - `processing_lane` 'no_sla' | 'sla_24h' | 'sla_12h' | 'sla_6h' | 'sla_1h' | 'instant': Start-SLA lane (wait-to-start guarantee, not completion). Values: no_sla (fair use ×1), sla_24h (×1.5), sla_12h (×2), sla_6h (×3), sla_1h (×4), instant (×5 interactive start). Prefer this over legacy numeric priority. If omitted: workspace default_processing_lane, else no_sla.

## Response `200`

Success

- object: Update workspace (settings, tier, AI-DMS)
  - `status` 'success' | 'error', required: Operation result status
  - `message` string: Human-readable status message
  - `workspace_tier` 'standard' | 'confidential' | 'compliance': Security level after the update
  - `ai_dms_backfill` object: AI-DMS backfill result (only on tier change)
    - `documents_queued` integer: Newly scheduled documents
    - `documents_tier_updated` integer: Documents with a changed tier
    - `ai_dms_tier` string: AI-DMS processing tier
    - `source` 'activation' | 'tier_change': Source
  - `processing_time` string: Request processing time (e.g. "123.45ms")

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)