Box Developer Documentation
Log in

Box Sign template

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A Box Sign template object

string
4206996024-14944f75-c34b-478a-95a1-264b1ff80d35

Template identifier.

string
sign-template

object type

Value is always sign-template

object

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

string array
["email_subject","name"]

Non editable fields.

object

Required fields.

array array
[["email"],["email"]]

Required signer fields.

string array
["email"]
boolean
true

Indicates if the template email settings are editable or not.

boolean
false

Indicates if the template input fields are editable or not.

boolean
true

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

boolean
true

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

boolean
false

Indicates if the template signers are editable or not.

object

Custom branding applied to notifications and signature requests.

string
9E5E6F

Custom branding color in hex.

string
Corporation inc.

Name of the company

string
Contact email email@mail.com

Content of the email footer.

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

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

integer
2
0
730

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.

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

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

string
Official contract

The name of the template.

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.

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.

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

string
Hello! Please sign the document below

Extra instructions for all signers.

boolean
false

Whether the ready sign link is enabled or not.

boolean
true

Whether to disable notifications when a signer has signed.

string
Official contract

Request name.

string
"https://app.box.com/sign/ ready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178"

The URL that can be sent to signers.

object array

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.

string
example@mail.com

Email address of the signer

object array
string
text

Type of input

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

boolean
true

Checkbox prefill value

string
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

object

Where the input is located on a page.

number
0.672258592471358

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

number
0.18654283173599448

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

string (date)
2021-04-26

Date prefill value

object

The size of the input.

number
0.05311728090109673

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

number
0.2618657937806874

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

string
123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7

Document identifier.

string
1234

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

string array
["Yes","No","Maybe"]

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

string
da317330-225a-4c72-89ad-0d6dcaaf4df6

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

boolean
true

Whether or not the input is required.

string
Legal name

The label field is used especially for text, attachment, radio, and checkbox type inputs.

integer
4

Index of page that the input is on.

boolean
true

Whether this input was defined as read-only(immutable by signers) or not

string
text

Text prefill value

boolean
true

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

string
Jane Doe

A placeholder label for the signer set by the template creator to differentiate between signers.

integer
2
0

Order of the signer

string
RJZYYVPR

An identifier for the signer. This can be used to identify a signer within the template.

string
signer
"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

string
cd4ff89-8fc1-42cf-8b29-1890dedd26d7

If 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.

File (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",
  "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@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": [
    {
      "email": "example@mail.com",
      "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,
      "label": "Jane Doe",
      "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"
    }
  ]
}