SIsignnow

Create link for document

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

Use the request body attributes to define where the link opens (the editor or the Send Invite page), configure redirect options, specify link expiration, and customize the sender’s email and name appearance.

For more information, see Embedded sending guide and check out our video tutorial.

<details open>

<summary>Video tutorial</summary>

<sub><sup>Note: The design shown in the video is outdated, but the flow is still accurate. You can go ahead and follow the steps as demonstrated.</sup></sub>

Video tutorial

</details>
post/v2/documents/{document_id}/embedded-sending

Request

Path parameters

ID of the requested document.

Request body

typestring required

The type of invite settings available by the link. Possible values: invite - the Send Invite page opens for the document where user add the signer's address, email subject and message etc.; document - the document opens in the editor for adding fillable fields, and then the Send Invite page opens.

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 the signing session ends.

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 the new tab in the browser, or in the same tab after the signing session. Possible values: blank - opens the link in the new tab, self - opens the link in the same tab, default value.

Example request

{
  "from_name": "Anna Green",
  "from_email": "sender@email.com"
}

Response

Returns the link for embedded sending in case of correct request.

Changes

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