Share document

This endpoint allows API users to share documents with one or more users. For each document-email pair, assign a viewer or sender role.

Notes

  • Viewer - can view and download the document; sender - can view, download, invite to sign, and manage document invites.
  • Only documents owned by the authenticated user may be shared.
  • If the recipient already has access, their role is updated to the value sent in the request.
  • The recipient receives an email notification with a link to the shared document.
  • If the recipient does not exist in the system, a new account is created automatically.
  • The document owner's email must not appear among the recipients.
  • Documents belonging to a document group cannot be shared individually.
  • Documents created from a template already shared with the target user are rejected with a conflict error.

Request limits: At most 100 distinct recipient emails and 20 distinct documents per request.

post/v2/shared-entities

Request

Request body

Example request

{
  "data": [
    {
      "role": "viewer",
      "email": "user@email.com",
      "message": "Please review the document.",
      "entity_id": "abc123def456abc123def456abc123def456abc1",
      "entity_type": "document"
    }
  ]
}

Response

Document successfully shared.

Changes

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