Titlestring | The title of the template. |
Descriptionstring | The description of the template. |
DocumentTitlestring | This is the name of the document that will be displayed in the BoldSign user interface as well as in the signature request email. |
DocumentMessagestring | The message that will be seen by all recipients. You can include any instructions related to this document that the signer should be aware of before signing. |
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 . namestring | The name of the Role. | indexintegerRequired | The row index of the role. The role index should be in linear increments for each role (1, 2, 3, and so on). The index value must be between 1 and 50. | defaultSignerNamestring | The signer name of the document. This name appears in all email communications, signing notifications, and the audit file. | defaultSignerEmailstring | The signer email of the document. This email appears in all email communications, signing notifications, and the audit file. | signerOrderinteger | The order of the signer. When you enable the signing order option, this will be required. The value must be between 1 and 50 . | signerTypestring | The type of the signer and the values are Signer , Reviewer , and InPersonSigner . | hostEmailstring | The host email address. It is a required property when the signerType is set to InPersonSigner . Your organization should have HostEmail. | languageinteger | The language for 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. The default language is 1-English . | 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 . The default locale language is EN-English . | imposeAuthenticationstring | This is used to allow authentication for a specific signer. We have three types of authentication. They are AccessCode , EmailOTP , SMSOTP and IdVerification . The default value is None . | phoneNumberobject | When the delivery mode is set to SMS or EmailAndSMS , 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. |
| deliveryModestring | This property allows you to specify the desired delivery mode for sending notifications. We have three types of delivery modes. They are Email , SMS and EmailAndSMS . The default value is Email . | allowFieldConfigurationboolean | 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. | formFieldsarray | List of fields associated with the signer. idstring | The id of the form field. ID must start with a letter or an underscore and can only contain letters, digits, and underscores. | namestring | The name of the form field. | typestring | Type of the form field. The available values are Signature , Initial , CheckBox , TextBox , Label , DateSigned , Image , Attachment , EditableDate , Hyperlink , Formula and Dropdown . The Formula field is only available in the beta version. Note : To add Email , Name , Title , and Company fields via API, use TextBox fields with the validation type set to Regex . | pageNumberinteger | This will be used to specify which page the form field should be placed on. The page number must be greater than zero. | boundsobject | This will contain the form field's x and y coordinates, width, and height. xfloat | The form field's x coordinate value. | yfloat | The form field's y coordinate value. | widthfloat | The form field's width. The width must be greater than zero. | heightfloat | The form field's height. The height must be greater than zero. |
| isRequiredboolean | When disabled, the signer does not want to fill out the form field. The default value is true . | tabIndexNullable int | Assign tab index to control the flow of field focus while using TAB key navigation. Default to null , which denotes it will follow regular flow. The accepted range starts from -1 to a valid integer . | labelstring | The label used to represent the value for a radio button. Also, can be used to prefill a radio button. | valuestring | The value of the form field. | fontSizeinteger | The fontsize of the form field. The default size font is 13.0 . | fontstring | Font family. The values are Courier , Helvetica , TimesNewRoman , and NotoSans . The default font family is Helvetica . | fontHexColorstring | The font color of the form field. | isBoldFontboolean | When enabled, the font will be displayed in bold. | isItalicFontboolean | When enabled, the font will be italic. | isUnderLineFontboolean | When enabled, the font will be displayed in Underline format. | lineHeightinteger | The line height of the form field. The default line height is 15.0 . | characterLimitinteger | The character limit in the form field. The character limit value must be greater than zero. | groupNamestring | The groupName of the form field. This field is required when the type is set to RadioButton . | placeHolderstring | The placeholder of the form field. | validationTypestring | The validation type of the text box form field. The available values are None , NumbersOnly , EmailAddress , Currency , and CustomRegex . The default value is None . | validationCustomRegexstring | The custom regex of the text box form field. When we set the ValidationType to CustomRegex , it will be required. | validationCustomRegexMessagestring | The text box field's custom regex message. This message is displayed when the signer enters an invalid regex format value in the text box form field while signing the document. | dateFormatstring | Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy . When null is provided, the value is inherited from the business profile settings of your account. Accepted formats areMM/dd/yyyy (02/08/2024)dd/MM/yyyy (08/02/2024)dd-MMM-yyyy (08-Feb-2024)MMM-dd-yyyy (Feb-08-2024)MMM dd, yyyy (Feb 08, 2024)dd MMM, yyyy (08 Feb, 2024)yyyy, MMM dd (2024, Feb 08)yyyy/MM/dd (2024/02/08)dd-MM-yyyy (08-02-2024)MM-dd-yyyy (02-08-2024)yyyy-MM-dd (2024-02-08)
| timeFormatstring | Format of the time to be displayed on the date signed form field. When null is provided, the value is inherited from the business profile settings of your account. Accepted formats arehh:mm tt (12:30 PM)h:mm tt (2:45 PM)HH:mm (14:30)H:mm (9:15)hh:mm:ss tt (12:30:15 PM)h:mm:ss tt (2:45:30 PM)HH:mm:ss (14:30:10)H:mm:ss (9:15:40)None (Disabled, no time will be displayed)
| imageInfoobject | The information about the image field. titlestring | The title of the image. | descriptionstring | The description of the image. | allowedFileExtensionsstring | This includes file extensions such as .jpg or .jpeg , .svg , .png , and .bmp . |
| attachmentInfoobject | The information about the attachment field. titlestring | The title of the attachment. | descriptionstring | The description of the attachment. | allowedFileTypesstring | The file types that can be used are .pdf , .docx , .jpg , .jpeg , and .png . |
| editableDateFieldSettingsobject | The settings for the editable date form field and it contains date format, min and max values. dateFormatstring | BoldSign API supports a variety of date-time formats, including: MM/dd/yyyy dd/MM/yyyy dd-MMM-yyyy MMM-dd-yyyy MMM dd,yyyy dd MMM,yyyy yyyy,MMM dd yyyy/MM/dd dd-MM-yyyy MM-dd-yyyy yyyy-MM-dd
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. The default ISO standard YYYY-MM-DDTHH:MM:SSZ . minDate : 2024-01-01T00:00:00Z The date-time should be passed in UTC timezone using Z (e.g., 2024-01-01T00:00:00Z ). If using a specific timezone, provide the UTC offset: - IST (UTC+5:30):
2024-01-01T00:00:00+05:30 - PST (UTC-8:00):
2024-01-01T00:00:00-08:00
| maxDate string | The maximum date that can be selected. The string should be in date-time format. The default ISO 8601 standard YYYY-MM-DDTHH:MM:SSZ . maxDate : 2025-12-31T23:59:59Z Pass the date-time in UTC timezone using Z (e.g., 2025-12-31T23:59:59Z ). For specific timezones, provide the UTC offset: - EST (UTC-5:00):
2025-12-31T23:59:59-05:00 - CET (UTC+1:00):
2025-12-31T23:59:59+01:00
|
| hyperlinkTextstring | The text of the hyperlink form field. | dataSyncTagstring | The value of the dataSync tag. | dropdownOptionsarray | The options of the dropdown form field. | textAlignstring | Determines the horizontal alignment of text for the textbox and label form fields, and can be set to Left , Center , or Right . The default of alignment of text is Left . | textDirectionstring | Determines the text direction of text for the textbox and label form fields, and can be set to LTR or RTL . The default text direction is LTR . | characterSpacingfloat | Determines the character spacing of text for the textbox and label form fields. It can be set as a floating-point value. | formulaFieldSettingsobject | Options to configure formula field. formulaExpressionstring | This property is used to specify the formula as a string define the calculation or expression for the formula field. | decimalPrecisioninteger | This property is used to determines the decimal rounding precision for the computed result. |
|
| allowRoleEditboolean | You can't change the signer details while sending the document out for signature if it's disabled. The default value is true . | allowRoleDeleteboolean | You can't remove the signer details while sending the document out for signature if it's disabled. The default value is true . | recipientNotificationSettingsobject | Control email notifications to recipients by configuring the properties within recipientNotificationSettings . signatureRequestboolean | Indicates whether the recipient should be notified when a document is sent. | declinedboolean | Indicates whether the recipient should be notified when a document is declined. | revokedboolean | Indicates whether the recipient should be notified when a document is revoked. | signedboolean | Indicates whether the recipient should be notified when a document is signed by other recipient. | completedboolean | Indicates whether the recipient should be notified when the document is completed. | expiredboolean | Indicates whether the recipient should be notified when a document expires. | reassignedboolean | Indicates whether the recipient should be notified when the document is reassigned. | deletedboolean | Indicates whether the recipient should be notified when a document is deleted. | remindersboolean | Indicates whether the recipient should receive reminders for pending signature requests. | editRecipientboolean | Indicates whether the recipient should be notified when there is an change in the recipient. | editDocumentboolean | Indicates whether the recipient should be notified when a document is edited. |
| enableQesNullable boolean | When set to true, the signer will be allowed to sign the document with a qualified electronic signature (QES). It can only be assigned to a single signer. When there are multiple signers in a document, the signer order option should be enabled to ensure only the last person in the document is enabled with QES, and the last signer order also should not have multiple signers. |
|
AllowNewFilesboolean | When set to true, the sender can add new files while using this template to send signature requests. If set to false, the sender will not be able to add new files. |
AllowModifyFilesboolean | When set to true, the sender can replace or delete existing files while using this template to send signature requests. If set to false, the sender will not have the ability to replace or delete files. |
CCarray | You can add anyone who needs to receive a copy of the signed document by adding their email address. |
BrandIdstring | You can customize the branding of signature request emails and document signing pages with your own colors, logos, and other elements. The brand id can be obtained from both the branding API and the web app branding page. |
AllowMessageEditingboolean | When disabled, you cannot change the message while creating a document with this template. The default value is true . |
AllowNewRolesboolean | When disabled, you cannot add additional signers to the document. The default value is true . |
EnableReassignboolean | When disabled, the reassign option is not available after sending the document out of signature. The default value is true . |
EnablePrintAndSignboolean | When enabled, the document can be printed and signed offline. The default value is false . |
EnableSigningOrderboolean | When enabled, signers can only sign the document in the order specified. Furthermore, the next signer will be notified when the previous signer has signed the document. The default value is false . |
DocumentInfoarray | This is used to specify the title and description of the document in the various supported languages. languageinteger | The language of the document. 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. The default language is 1-English . | titlestring | The title of the document. | descriptionstring | The description of 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 . The default locale language is EN-English . |
|
UseTextTagsboolean | When enabled, it will convert all the tags defined in the document to BoldSign form fields. The default value is false . |
TextTagDefinitionsarray | This can be used for the long text tag handling. definitionIdstring | The definition id of the text tag. | typestring | The type of the form field. | signerIndexinteger | The signer index of the form field. | isRequiredboolean | When disabled, the signer is not required to fill out the specific form field. The default value is true . | placeholderstring | The placeholder of the form field. | tabIndexNullable int | Assign tab index to control the flow of field focus while using TAB key navigation. Default to null , which denotes it will follow regular flow. The accepted range starts from -1 to a valid integer . | labelstring | The label used to represent the value for a radio button. Also, can be used to prefill a radio button. | fieldIdstring | The field id of the form field. | fontobject | The font of the form field. namestring | The name of the font in form field. The values are Courier , Helvetica , TimesNewRoman , and NotoSans . The default font family is Helvetica . | colorstring | The font color of the form field. | sizeinteger | The font size of the form field. | stylestring | The font style of the form field. The default font style is Regular . | lineHeightinteger | The lineheight of the form field. |
| validationobject | When we select the type as TextBox , the validation of the form field is required. typestring | The validation type of the text box form field. The available values are None , NumbersOnly , EmailAddress , Currency , and CustomRegex . The default value is None . | regexstring | The custom regex of the text box form field. When we set the ValidationType to CustomRegex , it will be required. |
| sizeobject | This can be used to specify the form field's height and width. widthfloat | The width of the form field. The width must be greater than zero. | heightfloat | The height of the form field. The height must be greater than zero. |
| dateFormatstring | Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy . When null is provided, the value is inherited from the business profile settings of your account. Accepted formats areMM/dd/yyyy (02/08/2024)dd/MM/yyyy (08/02/2024)dd-MMM-yyyy (08-Feb-2024)MMM-dd-yyyy (Feb-08-2024)MMM dd, yyyy (Feb 08, 2024)dd MMM, yyyy (08 Feb, 2024)yyyy, MMM dd (2024, Feb 08)yyyy/MM/dd (2024/02/08)dd-MM-yyyy (08-02-2024)MM-dd-yyyy (02-08-2024)yyyy-MM-dd (2024-02-08)
| timeFormatstring | Format of the time to be displayed on the date signed form field. When null is provided, the value is inherited from the business profile settings of your account. Accepted formats arehh:mm tt (12:30 PM)h:mm tt (2:45 PM)HH:mm (14:30)H:mm (9:15)hh:mm:ss tt (12:30:15 PM)h:mm:ss tt (2:45:30 PM)HH:mm:ss (14:30:10)H:mm:ss (9:15:40)None (Disabled, no time will be displayed)
| radioGroupNamestring | The form field's groupName, which is required when we set the type RadioButton . | valuestring | The value of the form field. | dropdownOptionsarray | The options of the dropdown form field. | offSetobject | Specifies the offset positioning for the text tag, allowing adjustments to its location relative to the computed position. The computed value after value must remain within the page dimensions. offSetXdouble | Adjusts the text tag's position horizontally (left or right). | offSetYdouble | Adjusts the text tag's position vertically (top or bottom). |
|
|
autoDetectFieldsboolean | When enabled, it will convert all the fillable form fields in the document to BoldSign form fields. BoldSign supports Textbox, Checkbox, Radio button, and Signature form fields. Other fields will not be detected as of now. The default value is false . |
labelsstring[ ] | The labels (Tags) that will be assigned to the document when a document is created using this template which can be used to categorize and filter the documents. Labels cannot contain whitespaces and must not exceed 255 characters. |
formGroupsarray | Manages the rules and configuration of grouped form fields. minimumCountinteger | The minimum number of items that must be selected in a form group. The minimum count value must be greater than zero. | maximumCountinteger | The maximum number of items that must be selected in a form group. The maximum count value must be greater than zero. | dataSyncTagstring | The data sync tag of the form group. | groupNamesarray | The group names to which this form group rule should be applied. | groupValidationstring | Specify the form group validation type, the available validations are Minimum , Maximum , Absolute , and Range . |
|
templateLabelsstring[ ] | The template labels (Tags) are added to the template to categorize and filter the documents. |
onBehalfOfstring | The email address of the user that was used to create the template on their behalf. |
recipientNotificationSettingsobject | Control email notifications to recipients or CC collectively by configuring properties within recipientNotificationSettings . signatureRequestboolean | Indicates whether the recipient or CC should be notified when a document is sent. | declinedboolean | Indicates whether the recipient or CC should be notified when a document is declined. | revokedboolean | Indicates whether the recipient or CC should be notified when a document is revoked. | signedboolean | Indicates whether the recipient or CC should be notified when a document is signed by other recipient. | completedboolean | Indicates whether the recipient or CC should be notified when the document is completed. | expiredboolean | Indicates whether the recipient or CC should be notified when a document expires. | reassignedboolean | Indicates whether the recipient or CC should be notified when the document is reassigned. | deletedboolean | Indicates whether the recipient or CC should be notified when a document is deleted. | remindersboolean | Indicates whether the recipient should receive reminders for pending signature requests. | editRecipientboolean | Indicates whether the recipient should be notified when there is a change in the recipient. | editDocumentboolean | Indicates whether the recipient or CC should be notified when the document is edited. | viewedboolean | Indicates whether the CC should be notified when the document is viewed. |
|