v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Box Sign templates

Get Box Sign template by ID

Fetches details of a specific Box Sign template.

get/sign_templates/{template_id}

Path parameters

template_idstring required

The ID of a Box Sign template.

Response

Returns details of a template.

type'sign-template'

The value will always be sign-template.

idstring

Template identifier.

namestring nullable

The name of the template.

email_subjectstring nullable

Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

email_messagestring nullable

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.

days_validinteger nullable

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.

are_fields_lockedboolean

Indicates if the template input fields are editable or not.

are_options_lockedboolean

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

are_recipients_lockedboolean

Indicates if the template signers are editable or not.

are_email_settings_lockedboolean

Indicates if the template email settings are editable or not.

are_files_lockedboolean

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

request_flowstring nullable

The sign flow of sign requests created from the template. Values can include standard or cfr11.

Example response

{
  "type": "sign-template",
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "name": "Official contract",
  "email_subject": "Sign Request from Acme",
  "email_message": "Hello! Please sign the document below",
  "days_valid": 2,
  "parent_folder": {
    "id": "12345",
    "etag": "1",
    "type": "folder",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "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"
      }
    }
  ],
  "are_options_locked": true,
  "are_email_settings_locked": true,
  "are_files_locked": true,
  "signers": [
    {
      "inputs": [
        {
          "document_tag_id": "1234",
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "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
          },
          "label": "Legal name",
          "read_only": true,
          "validation": {
            "validation_type": "email"
          }
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "label": "Jane Doe",
      "public_id": "RJZYYVPR",
      "is_password_required": true,
      "is_phone_number_required": true,
      "login_required": true
    }
  ],
  "additional_info": {
    "non_editable": [
      "email_subject",
      "name"
    ],
    "required": {
      "signers": [
        [
          "email"
        ],
        [
          "email"
        ]
      ]
    }
  },
  "ready_sign_link": {
    "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
    "name": "Official contract",
    "instructions": "Hello! Please sign the document below",
    "folder_id": "12345",
    "is_notification_disabled": true
  },
  "custom_branding": {
    "company_name": "Corporation inc.",
    "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
    "branding_color": "9E5E6F",
    "email_footer_text": "Contact email email@mail.com"
  },
  "request_flow": "standard"
}