Document AI — DMS

Update workspace share

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

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

Request body

share_idinteger 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_2faboolean

No longer supported on updates; the value is ignored and listed in ignored_fields (FIELD_REMOVED).

require_strict_email_matchboolean

When true, login email must exactly match the invited address.

folder_restrictionstring

JSON array of folder IDs the share may access (omit for full workspace).

expires_atstring date-time

ISO 8601 expiry timestamp (UTC).

telephony_enabledboolean

Enable or disable the telephony channel for this share.

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.