Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0.

Client id of the app you're using to create this draft.

Use file[] to indicate the uploaded file(s) to use for the template. Use file_url[] to have HelloSign download the file(s) to use for the template. Currently we only support use of either the file[] parameter or file_url[] parameter, not both.

The template title

The template title (alias)

The default template email message

The role name of the signer that will be displayed when the template is used to create a signature request. %i% is an integer that should uniquely identify a signer role.

The order in which this signer role is required to sign. %i% is an integer that should uniquely identify a signer role.

The name of attachment.

The instructions for uploading the attachment.

The signer's unique number, see signers[%i%][name] for more details.

Determines if the attachment must be uploaded.

The CC roles that must be assigned when using the template to send a signature request

The merge fields that can be placed on the template's document(s) by the user claiming the template draft. These are typically fields that can be pre-populated by your application when using the resulting template to send a signature request. Each merge field object must have two parameters: name and type. Names must be unique and type can only be "text" or "checkbox".

Disables the "Me (Now)" option for the person preparing the document. Defaults to 0.

[boolean] Enable the detection of predefined PDF fields by setting the use_preexisting_fields to "1" (defaults to disabled, or "0").

Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys, with key names up to 40 characters long and values up to 1000 characters long.

Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. Note: Only available for Gold plan and higher.

This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template

This allows the requester to specify field options for signature requests created using the template.

• date_format: [string] allows requester to specify the date format (see list of allowed formats)
  Note: Only available for Platinum and higher.

This allows the requester to specify editor options when a preparing a document.

• allow_edit_signers: [boolean] allows requesters to edit the list of signers (default: false)
• allow_edit_documents: [boolean] allows requesters to edit documents, including delete and add (default: false)

This allows the requester to enable the editor/preview experience.

• show_preview=1: [boolean] allows requesters to enable the editor/preview experience.
• show_preview=0: [boolean] allows requesters to disable the editor/preview experience.

The fields that should appear on the document, expressed as a 2-dimensional JSON array serialized to a string. The main array represents documents, with each containing an array of form fields. One document array is required for each file provided by the file[] parameter. In the case of a file with no fields, an empty list must be specified.

Each field must contain:
    1. api_id - (string) an identifier for the field that is unique across all documents in the request
    2. type - one of the Type options
    3. x & y - (int) location coordinates of the field in pixels
    4. page - (int) page in the document where the field should be placed (requires documents be PDF files)
        a. When the page number parameter is supplied, the API will use the new coordinate system.
        b. Check out the differences between both coordinate systems and how to use them.
    5. width & height - (int) size of the field in pixels
    6. required - (boolean) whether this field is required
    7. signer - (int | string) signer index identified by the offset %i% in the signers[%i%] parameter, indicating which signer should fill out the field. If your type is 'text-merge' you can set this to 'sender', so the field is non-editable by any signer.

Optionally, each field may contain a name (string) parameter. This is a display name for the field.

Each text field may contain a validation_type parameter. Check out the list of validation types to learn more about the possible values.

The following is an example of a form_fields_per_document for a 2-document request with a text field and signature field on the first page of the document, prior to serialization to a string for the API request:

[
    [
        {
            "api_id": "uniqueIdHere_1",
            "name": "",
            "placeholder": "",
            "type": "text",
            "x": 112,
            "y": 328,
            "width": 100,
            "height": 16,
            "required": true,
            "signer": 1,
            "page": 1,
            "validation_type": "numbers_only"
        },
        {
            "api_id": "uniqueIdHere_2",
            "name": "",
            "type": "signature",
            "x": 530,
            "y": 415,
            "width": 120,
            "height": 30,
            "required": true,
            "signer": 0,
            "page": 1
        }
    ]
]

Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.

The required shape of form_field_groups is

{
  "<group ID>": {
    "group_label": string,
    "requirement": string
  }
}

The following is an example of form_field_groups along with the required form_fields_per_document, prior to serialization to a string for the API request:

"form_fields_per_document": [
  [
    {
      "api_id": "uniqueIdHere_1",
      "name": "",
      "type": "radio",
      "x": 112,
      "y": 328,
      "width": 18,
      "height": 18,
      "required": false,
      "group": "RadioItemGroup1",
      "checked": 1,
      "signer": 0,
      "page": 1
    },
    {
      "api_id": "uniqueIdHere_2",
      "name": "",
      "type": "radio",
      "x": 112,
      "y": 370,
      "width": 18,
      "height": 18,
      "required": false,
      "group": "RadioItemGroup1",
      "checked": 0,
      "signer": 0,
      "page": 1
    }
  ]
],
"form_field_groups": {
  "RadioItemGroup1": {
    "group_label": "Radio Item Group 1",
    "requirement": "require_0-1"
  }
}

Conditional Logic rules for fields defined in form_fields_per_document.

• id: [string] must be unique
• trigger_operator: [string] currently only AND is supported
• triggers: [array] for identifying the "when" part of "when x do y"
• actions: [array] for identifying the "do" part of "when x do y"

The required shape of form_field_rules is

{
  {
    "id": string,
    "trigger_operator": "AND",
    "triggers": [
      {
        "id": string,
        "operator": string,
        "value": string|string[]|int
      }
    ],
    "actions": [
      {
        "field_id" | "group_id": string,
        "hidden": 0 | 1,
        "type": "change-field-visibility" | "change-group-visibility"
      }
    ]
  }
}

The following is an example of form_field_rules along with the required form_fields_per_document, prior to serialization to a string for the API request:

"form_fields_per_document": [
  [
    {
      "api_id": "uniqueIdHere_1",
      "name": "",
      "type": "text",
      "x": 112,
      "y": 328,
      "width": 100,
      "height": 16,
      "required": true,
      "signer": 0,
      "page": 1,
      "validation_type": "numbers_only"
    },
    {
      "api_id": "uniqueIdHere_2",
      "name": "",
      "type": "signature",
      "x": 530,
      "y": 415,
      "width": 120,
      "height": 30,
      "required": true,
      "signer": 0,
      "page": 1
    }
  ]
],
"form_field_rules": [
  {
    "id": "rule_1",
    "trigger_operator": "AND",
    "triggers": [
      {
        "id": "uniqueIdHere_1",
        "operator": "is",
        "value": "foo"
      }
    ],
    "actions": [
      {
        "field_id": "uniqueIdHere_2",
        "hidden": 1,
        "type": "change-field-visibility"
      }
    ]
  }
]