---
title: "Update workspace share"
method: POST
path: "/paperoffice_account/update_share"
tags: ["Document AI — DMS"]
---

# Update workspace share

`POST /paperoffice_account/update_share`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/paperoffice_account/update_share`
- Auth: HTTP bearer

Updates permissions and settings of an existing workspace share (owner only).

## Request body

- object
  - `share_id` integer, required: Workspace share ID to update or revoke.
  - `access_level` 'read' | 'upload': New permission for the share: read = view and download documents; upload = read plus uploading own documents. write, admin and view are rejected with 400 INVALID_ACCESS_LEVEL (no silent downgrade).
  - `require_2fa` boolean: No longer supported on updates; the value is ignored and listed in ignored_fields (FIELD_REMOVED).
  - `require_strict_email_match` boolean: When true, login email must exactly match the invited address.
  - `folder_restriction` string: JSON array of folder IDs the share may access (omit for full workspace).
  - `expires_at` string, date-time: ISO 8601 expiry timestamp (UTC).
  - `telephony_enabled` boolean: Enable or disable the telephony channel for this share.
  - `telephony_registered_phones` string[]: E.164 phone numbers allowed to call the share IVR (array of strings).
  - `telephony_pin` string: Optional PIN callers must enter after the voice prompt.
  - `telephony_language` string: IVR language code (e.g. de, en) for voice prompts.
  - `telephony_prompt_addon` string: Optional extra text appended to the spoken welcome prompt.
  - `telephony_voice` string: TTS voice ID override for telephony prompts (provider-specific).
  - `telephony_delivery_email` string, email: Email address for telephony access links or notifications.
  - `telephony_delivery_security_mode` string: How access credentials are delivered: link, pin, or sms.
  - `telephony_delivery_sms_phone` string: SMS destination when telephony_delivery_security_mode=sms.

## Response `200`

Success

- SuccessEnvelope: Success envelope. Payload fields are endpoint-specific (top-level fields, `result`/`job_result` for jobs, `data` on some account endpoints).
  - `status` 'success', required
  - `processing_time` union
    - string
    - number
  - `_billing` object

## 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)
