Create Embedded Request Url
POST {{apiBaseUrl}}/v1/template/createEmbeddedRequestUrl?templateId={{templateId}}
Generating the embedded request link is the same as sending the regular document but with additional properties to customize the embedded process.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
templateId | string | The ID of the existing template. |
Request Body
{"redirectUrl"=>"https://boldsign.com/esignature-api/", "showToolbar"=>true, "sendViewOption"=>"PreparePage", "showSaveButton"=>true, "showSendButton"=>true, "showPreviewButton"=>true, "showNavigationButtons"=>true, "sendLinkValidTill"=>"2022-10-15T10:30:18.928Z", "title"=>"LLC Operating Agreement", "message"=>"An LLC operating agreement is a legal document that governs the affairs, management, and ownership of a company.", "roles"=>[{"roleIndex"=>1, "signerName"=>"Luther Cooper", "signerOrder"=>1, "signerEmail"=>"luthercooper@cubeflakes.com", "privateMessage"=>"Kindly sign this article", "authenticationCode"=>"1234", "authenticationType"=>"AccessCode", "deliveryMode"=>"Email", "signerType"=>"signer", "signerRole"=>"HR", "locale"=>"EN"}], "brandId"=>"eb27a99a-9c09-477a-9903-b46df35a7f49", "labels"=>["curreny"], "reminderSettings"=>{"enableAutoReminder"=>true, "reminderDays"=>3, "reminderCount"=>5}, "cc"=>[{"emailAddress"=>"alexgayle@cubeflakes.com"}], "expiryDays"=>10, "expiryDateType"=>"Days", "expiryValue"=>60, "disableExpiryAlert"=>true, "enablePrintAndSign"=>true, "enableReassign"=>true}
RESPONSES
status: Created
{"documentId":"ad8618c5-xxxx-xxxx-xxxx-042e5a6666c5","sendUrl":"https://app.boldsign.com/document/embed/?documentId=12345678-xxxx-xxxx-xxxx-1234a78abc50_PAiswcuw;ef10f61f-5643-47f7-8210-c10bd1161e3c"}