Document AI — DMS

Update workspace

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...

post/documents/workspaces-update

Request

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

Request body

idinteger required

Workspace ID from workspaces-list (canonical).

namestring

New workspace name.

descriptionstring

New description.

workspace_tier'standard' | 'confidential' | 'compliance'

Security tier (only Upgrade erlaubt, no Downgrade).

is_revision_secureboolean

Enable revision-safe mode (one-time, irreversible).

retention_yearsinteger

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_localestring

Default language/region.

workspace_passwordstring

New workspace password.

statusstring

Workspace-Status.

typestring

Business workspace type (optional on update).

imagestring

Image URL.

priorityinteger

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_defaultboolean

Mark as standard.

is_stealthboolean

Stealth-Modus.

is_archivedboolean

Archiviert.

colorstring

Color code.

iconstring

Workspace icon key or emoji shown in the UI.

tagsstring[]

Comma-separated workspace tags for filtering.

contact_salutationstring

Contact salutation (e.g. Mr, Ms, Dr).

contact_firstnamestring

Contact given name for workspace metadata.

contact_lastnamestring

Contact family name for workspace metadata.

contact_emailstring

Contact email address for workspace metadata.

contact_phonestring

Contact phone number (E.164 recommended).

company_namestring

Company or organization name.

address_streetstring

Street address line.

address_zipstring

Postal or ZIP code.

address_citystring

City name.

address_countrystring

Country ISO 3166-1 alpha-2 code.

metadataobject

Additional metadata

password_enabledboolean

Enable or disable password protection.

sms_enabledboolean

SMS-Verifizierung enable.

sms_phonestring

Phone number for SMS verification.

dual_auth_enabledboolean

2-persons-approval enable.

dual_auth_phone_1string

Phone number Person 1.

dual_auth_phone_2string

Phone number Person 2.

workspace_idinteger

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

Success

status'success' | 'error' required

Operation result status

messagestring

Human-readable status message

workspace_tier'standard' | 'confidential' | 'compliance'

Security level after the update

processing_timestring

Request processing time (e.g. "123.45ms")

Changes

No recorded changes to this operation across all 1 revision of this API.