Box Sign template

A Box Sign template object

id string

example"4206996024-14944f75-c34b-478a-95a1-264b1ff80d35"

Template identifier.

additional_info object

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

additional_info.non_editable string array

example["email_subject","name"]

Non editable fields.

additional_info.required object

Required fields.

required.signers array array

example[["email"],["email"]]

Required signer fields.

[signers].[] string array

example["email"]

are_email_settings_locked boolean

exampletrue

Indicates if the template email settings are editable or not.

are_fields_locked boolean

examplefalse

Indicates if the template input fields are editable or not.

are_files_locked boolean

exampletrue

Indicates if the template files are editable or not. This includes deleting or renaming template files.

are_options_locked boolean

exampletrue

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

are_recipients_locked boolean

examplefalse

Indicates if the template signers are editable or not.

custom_branding object

Custom branding applied to notifications and signature requests.

custom_branding.branding_color string

example"9E5E6F"

Custom branding color in hex.

custom_branding.company_name string

example"Corporation inc."

Name of the company

custom_branding.email_footer_text string

example"Contact email email@mail.com"

Content of the email footer.

custom_branding.logo_uri string

example"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII="

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

days_valid integer

example2min0max730

Set 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 below"

Message 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 Acme"

Subject 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 contract"

The name of the template.

parent_folderFolder (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.

ready_sign_link.folder_id string

example"12345"

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.instructions string

example"Hello! Please sign the document below"

Extra instructions for all signers.

ready_sign_link.is_active boolean

examplefalse

Whether the ready sign link is enabled or not.

ready_sign_link.is_notification_disabled boolean

exampletrue

Whether to disable notifications when a signer has signed.

ready_sign_link.name string

example"Official contract"

Request name.

ready_sign_link.url string

example"\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\""

The URL that can be sent to signers.

signers object array

Array of signers for the template.

[signers].email string

example"example@mail.com"

Email address of the signer

[signers].inputs object array

[inputs].type string

example"text"

Type of input

Value is one of signature,date,text,checkbox,radio,dropdown

[inputs].checkbox_value boolean

exampletrue

Checkbox prefill value

[inputs].content_type string

example"text"

Content 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

[inputs].coordinates object

Where the input is located on a page.

coordinates.x number

example0.672258592471358

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

coordinates.y number

example0.18654283173599448

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

[inputs].date_value string / date-time

example"2021-04-26T08:12:13.982Z"

Date prefill value

[inputs].dimensions object

The size of the input.

dimensions.height number

example0.05311728090109673

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

dimensions.width number

example0.2618657937806874

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

[inputs].document_id string

example"123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7"

Document identifier.

[inputs].document_tag_id string

example"1234"

This references the ID of a specific tag contained in a file of the sign request.

[inputs].dropdown_choices string array

example["Yes","No","Maybe"]

When the input is of the type dropdown this values will be filled with all the dropdown options.

[inputs].group_id string

example"da317330-225a-4c72-89ad-0d6dcaaf4df6"

When the input is of type radio they can be grouped to gather with this identifier.

[inputs].is_required boolean

exampletrue

Whether or not the input is required.

[inputs].page_index integer

example4

Index of page that the input is on.

[inputs].text_value string

example"text"

Text prefill value

[signers].is_in_person boolean

exampletrue

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

[signers].order integer

example2min0

Order of the signer

[signers].role string

example"signer"default"signer"

Defines 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

source_filesFile (Mini) array

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

Response Example

{
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "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@mail.com",
    "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": [
    {
      "inputs": [
        {
          "document_tag_id": "1234",
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26T08:12:13.982Z",
          "type": "text",
          "content_type": "text",
          "is_required": true,
          "page_index": 4,
          "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "dropdown_choices": [
            "Yes",
            "No",
            "Maybe"
          ],
          "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
          "coordinates": {
            "x": 0.672258592471358,
            "y": 0.18654283173599448
          },
          "dimensions": {
            "width": 0.2618657937806874,
            "height": 0.05311728090109673
          }
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2
    }
  ],
  "source_files": [
    {
      "id": "12345",
      "etag": "1",
      "type": "file",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ]
}