Share document group template

This endpoint allows API users to share a document group template 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 template; sender - can view, download, make copies, invite to sign, and manage document invites.
  • Only the owner of the document group template can share it.
  • A document group template 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 template.
  • If the user does not exist in the system, a new account is created automatically.
post/v2/document-group-templates/{document_group_template_id}/roles

Request

Path parameters

Document group template 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 this template."
}

Response

Document group template successfully shared.

idstring

Unique identifier of the user.

rolestring

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

emailstring

Email address of the user.

Changes

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