send_document_from_template
Send documents for signing using a predefined template. Specify recipients, form field values, and sending options to create and deliver documents efficiently.
Instructions
Initiates the process of sending a document based on a pre-defined template. This tool allows you to specify recipients, form field values, and various sending options to create and send a document for signing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Optional. The main content and settings for sending the document. | |
| templateId | Yes | Required. The unique identifier (ID) of the template to be used for sending the document. This can be obtained from the list templates tool. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"additionalProperties": false,
"description": "Optional. The main content and settings for sending the document.",
"properties": {
"allowScheduledSend": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/signerDetails/anyOf/0/anyOf/1/properties/signerOrder/anyOf/0"
},
{
"type": "null"
}
],
"description": "Indicates whether scheduled sending is allowed for this document (e.g., 1 for allowed, 0 for not allowed)."
},
"brandId": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/existingFormFields/anyOf/0/anyOf/1/items/properties/id/anyOf/0/anyOf/1"
}
]
},
{
"type": "null"
}
],
"description": "The unique identifier (ID) of the brand to be associated with this document. If provided, the document will be branded accordingly."
},
"cc": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"additionalProperties": false,
"description": "Email address of the CC recipients.",
"properties": {
"emailAddress": {
"description": "Email address of the CC recipient.",
"format": "email",
"type": "string"
}
},
"required": [
"emailAddress"
],
"type": "object"
},
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. An array of email addresses to be added as carbon copy (CC) recipients to the document. CC recipients will receive a copy of the completed document."
},
"disableEmails": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Disables the sending of document related emails to all the recipients. The default value is false."
},
"disableExpiryAlert": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Disables the alert, which was shown one day before the expiry of the document."
},
"disableSMS": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Disables the sending of document related SMS to all the recipients. The default value is false."
},
"enablePrintAndSign": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Allows the signer to print the document, sign, and upload it. The default value is false."
},
"enableReassign": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Allows the signer to reassign the signature request to another person. The default value is true."
},
"enableSigningOrder": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Enables or disables the signing order. If this option is enabled, then the signers can only sign the document in the specified order and cannot sign in parallel. The default value is false."
},
"expiryDays": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/signerDetails/anyOf/0/anyOf/1/properties/signerOrder/anyOf/0"
},
{
"type": "null"
}
],
"default": 60,
"description": "The number of days after which the document expires. The default value is 60 days."
},
"fileUrls": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"description": "The URL of the file must be publicly accessible. The supported file formats are .pdf, .png, .jpg, and .docx. The preferred file format is .pdf. You can upload up to 25 files. Each document may have a maximum of 1000 pages and must be no larger than 25 MB in size.",
"format": "uri",
"minLength": 1,
"type": "string"
},
"maxItems": 25,
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. An array of URLs pointing to additional files to be attached to the document."
},
"hideDocumentId": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Decides whether the document ID should be hidden or not."
},
"message": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "A message for all the recipients. You can include the instructions that the signer should know before signing the document."
},
"reminderSettings": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"additionalProperties": false,
"properties": {
"enableAutoReminder": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "A flag indicating whether automatic reminders should be enabled for this document."
},
"reminderCount": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/signerDetails/anyOf/0/anyOf/1/properties/signerOrder/anyOf/0"
},
{
"type": "null"
}
],
"description": "The maximum number of reminders to be sent to the signers."
},
"reminderDays": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/signerDetails/anyOf/0/anyOf/1/properties/signerOrder/anyOf/0"
},
{
"type": "null"
}
],
"description": "The number of days after which a reminder should be sent to the signers."
}
},
"type": "object"
}
]
},
{
"type": "null"
}
],
"description": "Optional. Settings for automated reminders to be sent to the signers."
},
"roles": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"additionalProperties": false,
"properties": {
"allowFieldConfiguration": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "This option enables the signer to add fields at their end while signing the document. If this option is set to false, the signer cannot add fields, and they must complete the assigned ones. By default, it is set to false."
},
"authenticationCode": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "The authentication access code that the signer must enter to access the document. This should be shared with the signer privately by the sender."
},
"authenticationType": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"enum": [
"None",
"EmailOTP",
"AccessCode",
"SMSOTP"
],
"type": "string"
}
]
},
{
"type": "null"
}
],
"default": "None",
"description": "This is used to allow authentication for a specific signer. We have three types of authentication. They are AccessCode and EmailOTP. The default value is None."
},
"deliveryMode": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"enum": [
"Email",
"SMS"
],
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "The method by which the document should be delivered to the signer (e.g., 'Email', 'SMS'). When SMS is enabled, you should also provide the phone number."
},
"enableEmailOTP": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"default": false,
"type": "boolean"
}
]
},
{
"type": "null"
}
],
"description": "A flag indicating whether One-Time Password (OTP) via email should be enabled for this signer's authentication."
},
"enableQes": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "A flag indicating whether Qualified Electronic Signature (QES) should be enabled for this signer."
},
"existingFormFields": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "The unique identifier (ID) of the existing form field to be updated."
},
"index": {
"description": "The index of an existing form field to be updated.",
"type": "integer"
},
"isReadOnly": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/enableEmailOTP/anyOf/0"
},
{
"type": "null"
}
],
"description": "Decides whether this form field is read only or not."
},
"name": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "Optional name of the existing form field."
},
"value": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "Optional value of the existing form field."
}
},
"type": "object"
},
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. An array of existing form fields to be updated in the document for a role. When needed this information can be fetch from the get template tool to find the fillable form field for each signers."
},
"phoneNumber": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"additionalProperties": false,
"properties": {
"countryCode": {
"description": "Country code.",
"type": "string"
},
"number": {
"description": "Phone number.",
"type": "string"
}
},
"required": [
"countryCode",
"number"
],
"type": "object"
}
]
},
{
"type": "null"
}
],
"description": "The phone number of the signer, including the country code. Required for SMS authentication."
},
"privateMessage": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "Displays a private message to the specified signer when they proceed to sign the document. You can include the instructions that the signer should know before signing the document."
},
"roleIndex": {
"description": "The index of the role, indicating the position of the signer in the signing process. Must be between 1 and 50.",
"maximum": 50,
"minimum": 1,
"type": "number"
},
"signerDetails": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"additionalProperties": false,
"properties": {
"signerEmail": {
"description": "The email address of the signer assigned to this role. This is where the signing invitation will be sent.",
"type": "string"
},
"signerName": {
"description": "The name of the signer assigned to this role.",
"type": "string"
},
"signerOrder": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "number"
}
]
},
{
"type": "null"
}
],
"description": "The sequential order in which the signers in this role need to sign the document. Only relevant when 'enableSigningOrder' is true."
}
},
"required": [
"signerName",
"signerEmail"
],
"type": "object"
}
]
},
{
"type": "null"
}
],
"description": "Optional. The signer information for a template role."
},
"signerRole": {
"anyOf": [
{
"$ref": "#/properties/body/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "Optional. The user defined role of the signer, which was specified while creating the template."
},
"signerType": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"enum": [
"Signer",
"Reviewer"
],
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "The type of signer (e.g., 'Signer', 'Reviewer')."
}
},
"required": [
"roleIndex"
],
"type": "object"
},
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. An array defining the roles and associated signers for the document."
},
"scheduledSendTime": {
"anyOf": [
{
"$ref": "#/properties/body/properties/roles/anyOf/0/anyOf/1/items/properties/signerDetails/anyOf/0/anyOf/1/properties/signerOrder/anyOf/0"
},
{
"type": "null"
}
],
"description": "This property allows you to specify the date and time in Unix Timestamp format to schedule a document for sending at a future time. The scheduled time must be at least 30 minutes from the current time and must not exceed the document's expiry date."
},
"title": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "This is the title of the document that will be displayed in the BoldSign user interface as well as in the signature request email."
}
},
"type": "object"
},
"templateId": {
"description": "Required. The unique identifier (ID) of the template to be used for sending the document. This can be obtained from the list templates tool.",
"type": "string"
}
},
"required": [
"templateId",
"body"
],
"type": "object"
}