SIsignnow

Share document group

This endpoint allows API users to share a document group with a user by email, assigning them a specified role. If the user does not have an account, one is created automatically.

Notes

  • Viewer - can view, download, and make copies of documents in a document group; sender - can view, download, make copies, invite to sign, and manage document invites.
  • Only the owner of the document group can share it.
  • A document group can be shared only once with the same user. Attempting to share again (even with a different role) returns an error.
  • The user receives an email notification about the shared document group, including a preview link.
  • If the user does not exist in the system, a new account is created automatically.
  • If the document group was created from a document group template (DGT) that is already shared with the target user (as owner or sender), the sharing is rejected with a conflict error.
post/v2/document-groups/{document_group_id}/roles

Request

Path parameters

Document group ID.

Request body

rolestring required

Role to assign. Allowed values: viewer, sender.

emailstring required

Email address of the user to share with.

messagestring

Custom message to include in the notification email.

Example request

{
  "role": "viewer",
  "email": "user@email.com",
  "message": "Please review the documents."
}

Response

Document group successfully shared.

idstring

Unique identifier of the user.

rolestring

User's role in the document group (e.g., viewer, sender).

emailstring

Email address of the user.

Changes

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