Document AI — DMS

Create workspace share

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

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

Request body

workspace_idinteger required

Workspace ID to share

target_emailstring email

Recipient email (required when share_document_access=true)

share_document_accessboolean

Enable email/document channel

telephony_enabledboolean

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.

messagestring

Invitation message

expires_daysinteger

Share validity in days (1–3650, default 30).

require_2faboolean

No longer supported; ignored (external recipients sign in with their own account security).

require_strict_email_matchboolean

When true, login email must exactly match target_email.

folder_restrictionstring

Optional folder restriction JSON

telephony_registered_phonesstring[]

E.164 phone numbers allowed to call the share IVR (array of strings).

telephony_pinstring

Optional PIN callers must enter after the voice prompt.

telephony_languagestring

IVR language code (e.g. de, en) for voice prompts.

telephony_prompt_addonstring

Optional extra text appended to the spoken welcome prompt.

telephony_voicestring

TTS voice ID override for telephony prompts (provider-specific).

telephony_delivery_emailstring email

Email address for telephony access links or notifications.

telephony_delivery_security_modestring

How access credentials are delivered: link, pin, or sms.

telephony_delivery_sms_phonestring

SMS destination when telephony_delivery_security_mode=sms.

Response

Success

status'success' required
_billingobject

Changes

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