Send document from template

post/v1/template/send

Templates are created in the same way as regular documents, but instead of associating signature fields with people, we simply associate fields with roles. For more information, please refer to the Create template article.

When you need to send the same contracts out for signature to different groups of people repeatedly, you can use templates to save time. This section demonstrates how to send a document for signature by using an existing template.

Code snippet

curl -X 'POST' \ 'https://api.boldsign.com/v1/template/send?templateId=b8085b47-63b3-47f8-8d5e-cb0acfe2d916' \
     -H 'accept: application/json' \
     -H 'X-API-KEY: {your API key}' \
     -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
     -d '{
       "title": "Invitation form",
       "message": "Kindly review and sign this.",
       "roles": [
    {
      "roleIndex": 50,
      "signerName": "Richard",
      "signerOrder": 1,
      "signerEmail": "richard@cubeflakes.com",
      "privateMessage": "Please check and sign the document.",
      "authenticationCode": "281028",
      "enableEmailOTP": false,
      "signerType": "Signer",
      "signerRole": "Manager",
     "formFields": [
    {
      "id": "SignField",
      "fieldType": "Signature",
      "pageNumber": 1,
      "bounds": {
        "x": 100,
        "y": 100,
        "width": 100,
        "height": 50
      },
      "isRequired": true
    },
  ],      
      "locale": "EN"
    }
  ],
  "brandId": "8208b6d3-7ee0-4a1a-b597-1bbe41018107",
  "labels": [
    "Invitation"
  ],
  "disableEmails": false,
  "hideDocumentId": true,
  "reminderSettings": {
    "enableAutoReminder": true,
    "reminderDays": 3,
    "reminderCount": 10
  },
  "cc": [
    {
      "emailAddress": "alexgayle@cubeflakes.com"
    }
  ],
  "expiryDays": 180,
  "expiryDateType": "Days",
  "expiryValue": 60,
  "disableExpiryAlert": true,
  "enablePrintAndSign": true,
  "enableReassign": true,
  "enableSigningOrder": true,
  "useTextTags": true,
  "roleRemovalIndices": [1, 2],
  }`

var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}");
var templateClient = new TemplateClient(apiClient);
var signatureField = new FormField(
  id: "sign_id",
  type: FieldType.Signature,
  pageNumber: 1,
  bounds: new Rectangle(x: 100, y: 100, width: 100, height: 50));
  
  var formFieldsCollections = new List<FormField>
  {
    signatureField,
  };
    
  var templateRole = new Roles(
    roleIndex:3,
    signerName:"David",
    signerEmail:"david@cubeflakes.com",
    formFields: formFieldsCollections);
      
  var roles = new List<Roles>
  {
    templateRole,
  };
      
  var sendForSignFromTemplate = new SendForSignFromTemplate()
  {
    TemplateId = "01c19aef-2dad-476d-b801-7178ef2e1036",
    Roles = roles,
    RoleRemovalIndices = new [] {1, 2}
  };
            
var documentCreated =  templateClient.SendUsingTemplate(sendForSignFromTemplate);

import requests

url = "https://api.boldsign.com/v1/template/send?templateId=b67e6933-xxxx-xxxx-xxxx-a613cd83b5cd"

payload = "{\n  \"roles\": [\n    {\n      \"roleIndex\": 3,\n      \"signerName\": \"David\",\n      \"signerEmail\": \"david@cubeflakes.com\",\n      \"formFields\": [\n        {\n          \"fieldType\": \"Signature\",\n          \"pageNumber\": 1,\n          \"bounds\": {\n            \"x\": 100,\n            \"y\": 100,\n            \"width\": 100,\n            \"height\": 50\n          }\n        }\n      ]\n    }\n  ]\n, \n \"roleRemovalIndices\" : [\n 1, \n 2] \n}"
headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your API key}',
  'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

const axios = require('axios');
const response = await axios.post(
    'https://api.boldsign.com/v1/template/send',
    {
        'roles': [
            {
                'roleIndex': 3,
                'signerName': 'David',
                'signerEmail': 'david@cubeflakes.com',
                'formFields': [
                    {
                        'fieldType': 'Signature',
                        'pageNumber': 1,
                        'bounds': {
                            'x': 100,
                            'y': 100,
                            'width': 100,
                            'height': 50
                        }
                    }
                ]
            }
        ],
        'roleRemovalIndices': [1, 2]
    },
    {
        params: {
            'templateId': 'b67e6933-xxxx-xxxx-xxxx-a613cd83b5cd'
        },
        headers: {
            'accept': 'application/json',
            'X-API-KEY': '{your API key}',
            'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
        }
    }
);

Query parameters

templateIdstringRequired

The ID of the existing template to be used for sending the document.

Request body

titlestring This is the title of the document that will be displayed in the BoldSign user interface as well as in the signature request email.

messagestring A message for all the recipients. You can include the instructions that the signer should know before signing the document.

rolesarray

A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles, Customer and Representative.

roleIndexinteger The row index value of the role. The index value must be between 1 and 50.

signerNamestring Name of the signer. This name will appear on all the emails, notifications, and audit files.

signerOrderinteger Signing order of the signer. This is applicable when the signing order option is enabled.

signerEmailstring Mail ID of the signer. This ID will appear on all the emails, notifications, and on the audit file.

hostEmailstring Mail ID of the host. It is applicable when the signerType is set to InPersonSigner.

privateMessagestring Displays a 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.

authenticationTypestring This is used to allow authentication for a specific signer. We have three types of authentication. They are AccessCode, EmailOTP, and SMSOTP. The default value is None.

phoneNumberobject

When the authentication type is specified as SMSOTP, you can provide the phone number with the country code.

countryCodestring	This property represents the country code associated with the phone number.
numberstring	This property represents the actual phone number.

authenticationCodestring The authentication access code, which must be entered by the signer to access the document. This should be shared to the signer.

enableEmailOTPboolean Enables the email OTP authentication. When this feature is enabled, the signer is required to input the OTP (One-Time Password) received via email in order to access the document.

signerTypeSignerType Type of the signer. The values are Signer, Reviewer, and InPersonSigner.

signerRolestring The role of the signer which was specified while creating the template.

formFieldsarray

List of form fields associated with the signer.

idstring The ID of the form field.

namestring Name of the form field.

typestring Type of the form field. The available values are Signature, Initial, CheckBox, TextBox, Label, DateSigned, RadioButton, Image, Attachment, EditableDate, Hyperlink, and Dropdown.

pageNumberinteger Page number in the document, in which the form field has to be placed.

boundsRectangle

Position and size values of the form field to be placed.

xfloat	X-coordinate value used to place the form field.
yfloat	Y-coordinate value used to place the form field.
widthfloat	Width of the form field.
heightfloat	Height of the form field.

isRequiredboolean Decides whether this form field is required to be filled or not.

valuestring Value to be displayed on the label form field.

fontSizefloat Size of the font.

fontstring Font family. The values are Courier, Helvetica, and TimesNewRoman.

fontHexColorstring Color of the font. The value should be a hex color code. Example - #035efc.

isBoldFontboolean Decides whether the font should be in bold or not.

isItalicFontboolean Decides whether the font should be in italic or not.

isUnderLineFontboolean Decides whether the font should be underlined or not.

lineHeightinteger Height of a line in the text.

characterLimitinteger Limits the number of characters in the text.

groupNamestring The group name of the form field. This field is required when the fieldType is set to RadioButton.

placeHolderstring A hint text to be displayed on the text form field by default.

validationTypeValidationType Type of validation for the textbox form field. The values are Only Numbers, Regex, Currency, Email, and None.

validationCustomRegexstring Value for regex validation. This is applicable when the validationType is set to Regex.

validationCustomRegexMessagestring Description for regex validation. This message is displayed when the signer enters an invalid regex format value in the text box form field.

dateFormatstring Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy.

imageInfoobject

Options to customize the image form field.

titlestring	Title of the image form field.
descriptionstring	Description of the image form field.
allowedFileExtensionsstring	Controls the image formats that can be allowed to upload on the image form field. The values are `.jpg` or `.jpeg,` `.svg,` `.png,` and `.bmp.`

attachmentInfoobject

Options to customize the attachment form field.

titlestring	Title of the attachment form field.
descriptionstring	Description of the image form field.
allowedFileTypesstring	Controls the file formats that can be allowed to upload on the attachment form field. The values are `PDF,` `Document,` and `Image.`

editableDateFieldSettingsobject

Options to customize the editable date form field.

dateFormatstring	Format of the date to be displayed on the date signed form field. The default value is `MM/dd/yyyy`.
minDatestring	The minimum date that can be selected. The string should be in date-time format.
maxDatestring	The maximum date that can be selected. The string should be in date-time format.

hyperLinkTextstring Text to be displayed for the hyperlink.

dataSyncTagstring The value that can be specified on two or more textbox form fields to sync them.

dropDownOptionsarray The values which have to be displayed on the dropdown form field. One or more values can be specified.

textAlignstring Determines the horizontal alignment of text for the textbox and label form fields, and can be set to Left, Center, or Right.

textDirectionstring Determines the text direction of text for the textbox and label form fields, and can be set to LTR or RTL.

characterSpacingfloat Determines the character spacing of text for the textbox and label form fields. It can be set as a floating-point value.

existingFormFieldsarray

List of existing form fields in the document.

indexinteger	Index of the existing form field.
idstring	The ID of the existing form field.
valuestring	Value of the existing form field.
isReadOnlyboolean	Decides whether this form field is readOnly or not.

languageinteger Index of the language in which the document signing pages and emails for the signer should be rendered. The supported languages are 1-English, 2-Spanish, 3-German, 4-French, and 5-Romanian. Note that 'locale' should now be used instead of 'language' as it has replaced the deprecated term.

localestring Specify the language index for rendering document signing pages and emails for the signer, choosing from the supported locales such as EN-English, NO-Norwegian, FR-French, DE-German,ES-Spanish, BG-Bulgarian, CS-Czech, DA-Danish,IT-Italian, NL-Dutch, PL-Polish, PT-Portuguese,RO-Romanian, RU-Russian, and SV-Swedish.

brandIdstring You can customize the logo, colors, and other elements of the signature request emails and document signing pages to match your company branding. The ID of the existing brand can be obtained from the branding API and from the web app.

labelsarray Labels (tags) are added to the documents to categorize and filter them. One or more labels can be added.

disableEmailsboolean Disables the sending of document related emails to all the recipients. The default value is false.

hideDocumentIdboolean Decides whether the document ID should be hidden or not.

reminderSettingsboolean

Options to customize the auto-reminder settings.

enableAutoReminderboolean	Enables or disables the auto-reminder.
reminderDaysinteger	The number of days between each automatic reminder.
reminderCountinteger	The number of times the auto-reminder should be sent.

ccarray

Mail ID of the CC recipients. One or more CC recipients can be specified.

emailAddressstring

Mail ID of the CC recipients.

expiryDaysinteger The number of days after which the document expires. The default value is 60 days.

enablePrintAndSignboolean Allows the signer to print the document, sign, and upload it. The default value is false.

enableReassignboolean Allows the signer to reassign the signature request to another person. The default value is true.

enableSigningOrderboolean 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 parallelly. The default value is false.

disableExpiryAlertboolean Disables the alert, which was shown one day before the expiry of the document.

documentInfoarray

Options to customize the information like title and description of the document for a particular signer.

languageinteger	This specifies the language in which the document signing pages and emails should be rendered to the signer. The supported languages are `1-English,` `2-Spanish,` `3-German,` `4-French,` and `5-Romanian.` Note that 'locale' should now be used instead of 'language' as it has replaced the deprecated term.
titlestring	Title of the document.
Descriptionstring	A message for the signer. You can include the instructions that the signer should know before signing the document.
localestring	Specify the language index for rendering document signing pages and emails for the signer, choosing from the supported locales such as `EN-English`, `NO-Norwegian`, `FR-French`, `DE-German`,`ES-Spanish`, `BG-Bulgarian`, `CS-Czech`, `DA-Danish`,`IT-Italian`, `NL-Dutch`, `PL-Polish`, `PT-Portuguese`,`RO-Romanian`, `RU-Russian`, and `SV-Swedish`.

onBehalfOfstring Mail ID of the user to send the document on behalf of them.

roleRemovalIndicesarray Removes the roles present in the template with their indices given in this property.

Example response

200 Success

{
  "documentId": "755195d8-xxxx-xxxx-xxxx-88ff77d35419"
}