Box Sign template - Box Dev Docs

API version 2024.0 A Box Sign template object.

string

example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35Template identifier.

type

string

example: sign-templateThe value will always be sign-template.Value is always sign-template

additional_info

object

Additional information on which fields are required and which fields are not editable.

Show child attributes

non_editable

stringarray

example: ["email_subject","name"]Non editable fields.

required

object

Required fields.

Show child attributes

signers

arrayarray

example: [["email"],["email"]]Required signer fields.

Show child attributes

[]

stringarray

example: ["email"]

are_email_settings_locked

boolean

example: trueIndicates if the template email settings are editable or not.

are_fields_locked

boolean

example: falseIndicates if the template input fields are editable or not.

are_files_locked

boolean

example: trueIndicates if the template files are editable or not. This includes deleting or renaming template files.

are_options_locked

boolean

example: trueIndicates if the template document options are editable or not, for example renaming the document.

are_recipients_locked

boolean

example: falseIndicates if the template signers are editable or not.

custom_branding

object

Custom branding applied to notifications and signature requests.

Show child attributes

branding_color

string

example: 9E5E6FCustom branding color in hex.

company_name

string

example: Corporation inc.Name of the company.

email_footer_text

string

example: Contact email [email protected]Content of the email footer.

logo_uri

string

example:

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA         AAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A         8AAQUBAScY42YAAAAASUVORK5CYII=

Custom branding logo URI in the form of a base64 image.

days_valid

integer

example: 2Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.

email_message

string

example: Hello! Please sign the document belowMessage to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

email_subject

string

example: Sign Request from AcmeSubject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

name

string

example: Official contractThe name of the template.

parent_folder

Folder (Mini)object

The destination folder to place final, signed document and signing log. Only ID and type fields are required. The root folder, folder ID 0, cannot be used.

ready_sign_link

object

Box’s ready-sign link feature enables you to create a link to a signature request that you’ve created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.

Show child attributes

folder_id

string

example: 12345The destination folder to place final, signed document and signing log. Only ID and type fields are required. The root folder, folder ID 0, cannot be used.

instructions

string

example: Hello! Please sign the document belowExtra instructions for all signers.

is_active

boolean

example: falseWhether the ready sign link is enabled or not.

is_notification_disabled

boolean

example: trueWhether to disable notifications when a signer has signed.

name

string

example: Official contractRequest name.

url

string

example: "https://app.box.com/sign/ ready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178"The URL that can be sent to signers.

signers

object[]

Array of signers for the template.Note: It may happen that some signers specified in the template belong to conflicting segments (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.Read more about segments and ethical walls.

Show child attributes

string

example: [email protected]Email address of the signer.

inputs

object[]

Show child attributes

type

string

example: textType of input.Value is one of signature,date,text,checkbox,attachment,radio,dropdown

checkbox_value

boolean

example: trueCheckbox prefill value.

content_type

string

example: textContent type of input.Value is one of signature,initial,stamp,date,checkbox,text,full_name,first_name,last_name,company,title,email,attachment,radio,dropdown

coordinates

object

Where the input is located on a page.

Show child attributes

number

example: 0.672258592471358Relative x coordinate to the page the input is on, ranging from 0 to 1.

number

example: 0.18654283173599448Relative y coordinate to the page the input is on, ranging from 0 to 1.

date_value

string(date)

example: 2021-04-26Date prefill value.

dimensions

object

The size of the input.

Show child attributes

height

number

example: 0.05311728090109673Relative height to the page the input is on, ranging from 0 to 1.

width

number

example: 0.2618657937806874Relative width to the page the input is on, ranging from 0 to 1.

document_id

string

example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7Document identifier.

document_tag_id

string

example: 1234This references the ID of a specific tag contained in a file of the signature request.

example: ["Yes","No","Maybe"]When the input is of the type dropdown this values will be filled with all the dropdown options.

group_id

string

example: da317330-225a-4c72-89ad-0d6dcaaf4df6When the input is of type radio they can be grouped to gather with this identifier.

is_required

boolean

example: trueWhether or not the input is required.

label

string

example: Legal nameThe label field is used especially for text, attachment, radio, and checkbox type inputs.

page_index

integer

example: 4Index of page that the input is on.

read_only

boolean

example: trueWhether this input was defined as read-only(immutable by signers) or not.

text_value

string

example: textText prefill value.

is_in_person

boolean

example: trueUsed in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next in_person signer.

is_password_required

boolean

example: trueIf true for signers with a defined email, the password provided when the template was created is used by default. If true for signers without a specified / defined email, the creator needs to provide a password when using the template.

is_phone_number_required

boolean

example: trueIf true for signers with a defined email, the phone number provided when the template was created is used by default. If true for signers without a specified / defined email, the template creator needs to provide a phone number when creating a request.

label

string

example: Jane DoeA placeholder label for the signer set by the template creator to differentiate between signers.

example: trueIf true, the signer is required to login to access the document.

order

integer

example: 2Order of the signer.

public_id

string

example: RJZYYVPRAn identifier for the signer. This can be used to identify a signer within the template.

role

string

example: signerDefines the role of the signer in the signature request. A role of signer needs to sign the document, a role approver approves the document and a final_copy_reader role only receives the final signed document and signing log.Value is one of signer,approver,final_copy_reader

signer_group_id

string

example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7If provided, this value points signers that are assigned the same inputs and belongs to same signer group. A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used within Box Sign requests created from it.

source_files

File (Mini)array

List of files to create a signing document from. Only the ID and type fields are required for each file.

{
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "type": "sign-template",
  "additional_info": {
    "non_editable": [
      "email_subject",
      "name"
    ],
    "required": {
      "signers": [
        [
          "email"
        ],
        [
          "email"
        ]
      ]
    }
  },
  "are_email_settings_locked": true,
  "are_fields_locked": false,
  "are_files_locked": true,
  "are_options_locked": true,
  "are_recipients_locked": false,
  "custom_branding": {
    "branding_color": "9E5E6F",
    "company_name": "Corporation inc.",
    "email_footer_text": "Contact email [email protected]",
    "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII="
  },
  "days_valid": 2,
  "email_message": "Hello! Please sign the document below",
  "email_subject": "Sign Request from Acme",
  "name": "Official contract",
  "parent_folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "ready_sign_link": {
    "folder_id": "12345",
    "instructions": "Hello! Please sign the document below",
    "is_active": false,
    "is_notification_disabled": true,
    "name": "Official contract",
    "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\""
  },
  "signers": [
    {
      "email": "[email protected]",
      "inputs": [
        {
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "document_tag_id": "1234",
          "text_value": "text",
          "content_type": "text",
          "coordinates": {
            "x": 0.672258592471358,
            "y": 0.18654283173599448
          },
          "dimensions": {
            "height": 0.05311728090109673,
            "width": 0.2618657937806874
          },
          "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "dropdown_choices": [
            "Yes",
            "No",
            "Maybe"
          ],
          "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
          "is_required": true,
          "label": "Legal name",
          "page_index": 4,
          "read_only": true,
          "type": "text"
        }
      ],
      "is_in_person": true,
      "is_password_required": true,
      "is_phone_number_required": true,
      "label": "Jane Doe",
      "login_required": true,
      "order": 2,
      "public_id": "RJZYYVPR",
      "role": "signer",
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7"
    }
  ],
  "source_files": [
    {
      "etag": "1",
      "id": "12345",
      "type": "file",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "name": "Contract.pdf",
      "sequence_id": "3",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
    }
  ]
}