Sharings

Update document access

Changed on

Update a recipient's role.

patch/v1beta/documents/{document_id}/share/{recipient_id}

Request

  • Base URL
    https://api.factify.com
  • URL
    https://api.factify.com/v1beta/documents/{document_id}/share/{recipient_id}
  • Auth
    HTTP bearer

Path parameters

document_idstring required

Document ID.

Example:doc_01h2xcejqtf2nbrexx3vqjhp41
recipient_idstring required

Recipient ID (TypeID: user_xxx or bot_xxx).

Example:user_01h2xcejqtf2nbrexx3vqjhp41

Request body

document_role'viewer' | 'commenter' | 'collaborator' | 'admin' | 'owner' required

Response

Success

errorstring

Error message if the update failed.

successboolean

Whether the update succeeded.

Changes