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

# Create workspace share

`POST /paperoffice_account/share_workspace`

## Request

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

Create an external workspace share (email and/or telephony channel).

## Request body

- object
  - `workspace_id` integer, required: Workspace ID to share
  - `target_email` string, email: Recipient email (required when share_document_access=true)
  - `share_document_access` boolean: Enable email/document channel
  - `telephony_enabled` boolean: Enable telephony channel
  - `access_level` 'read' | 'upload': External share permission model (only these two values): read = view and download documents; upload = read plus uploading own documents. External shares never get edit or admin rights; write, admin and view are rejected with 400 INVALID_ACCESS_LEVEL.
  - `message` string: Invitation message
  - `expires_days` integer: Share validity in days (1–3650, default 30).
  - `require_2fa` boolean: No longer supported; ignored (external recipients sign in with their own account security).
  - `require_strict_email_match` boolean: When true, login email must exactly match target_email.
  - `folder_restriction` string: Optional folder restriction JSON
  - `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

- `201`: Created
- `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)