SIsignnow

Create link for doc group

This endpoint allows API users to create a link for embedded document group sending.

Add the type attribute to the payload to specify the sending step at which the embedded link should open and to control what actions the sender can perform.

  • manage: The link opens on the Add documents to document group page (default).
  • edit: The link opens in the editor, allowing the sender to add fields and send the invite.
  • send-invite: The link opens on the Send Invite page.

Use the request body attributes to configure redirect options, specify link expiration, and customize the sender’s email and name appearance.

For more information, see Embedded sending guide.

post/v2/document-groups/{document_group_id}/embedded-sending

Request

Path parameters

ID of the requested document group.

Request body

typestring

Specifies the sending step at which the embedded link should open: manage — opens the link on the Add documents to document group page (default); edit— opens the link in the editor; send-invite — opens the link on the Send Invite page.

from_namestring

Use this attribute to customize the name that appears: 1) on the Send Invite page (From, Invite Email Subject, and Invite Email Message); 2) in the invite and reassign emails: in email subject and email body; 3) in the signing session: as the name in From in the header and on the detailed From card.

from_emailstring

Use this attribute to customize the email address that appears: 1) [part before @]on the Send Invite page (From, Invite Email Subject, and Invite Email Message) 2) in the invite and reassign emails: [part before @] in email subject and email body; when clicking Contact Sender and in Reply-to; 3) in the signing session: as the email in From in the header and on the detailed From card; when clicking Contact Sender in the More Actions menu and on the detailed From card.

redirect_uristring

The page that opens after embedded sending has been set up. Required if redirect_target is added.

link_expirationinteger

Specifies how many minutes the link remains active. The allowed range is 15 to 45 minutes.

redirect_targetstring

Determines whether to open the redirect link in a new tab in the browser or in the same tab. Possible values: blank - opens the link in a new tab, self - opens the link in the same tab (default).

Example request

{
  "from_name": "Anna Green",
  "from_email": "sender@email.com",
  "redirect_uri": "https://www.signnow.com/"
}

Response

Returns the link for embedded sending.

Changes

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