Configuring the embedded link expiration using API
In BoldSign, the default expiration for an embedded link is set to 180 days. This means that the link will expire 180 days after its creation. However, the expiration date is not fixed and can be adjusted according to the user’s needs.
Embedded links can be created for five different scenarios:
- Sending a document
- Sending a document using a template
- Signing a document
- Creating a template
- Editing an already created template
The expiration date of an embedded link can also be set during the creation of the link. The range for setting the expiration date is between 1 and 180 days.
Here are some code examples to create embedded request links from a template by setting an expiration date.
Code snippet
curl --location --request POST 'https://api.boldsign.com/v1/template/createEmbeddedRequestUrl?templateId=<template-id>' \
--header 'X-API-KEY: {Your-API-KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
"showToolbar": true,
"sendViewOption": "FillingPage",
"showSaveButton": true,
"showSendButton": true,
"locale": "EN",
"showPreviewButton": true,
"showNavigationButtons": true,
"showTooltip": false,
"linkValidTill": "2024-01-15T08:30:00"
}' \
In the above example, replace <template-id>
with the ID of the template you want to use to create an embedded request link. Set the linkValidTill
property to your desired expiration date. Upon executing the above code, an embedded link will be generated with the set expiration date. This link can then be used to send a document out for signature before it expires.