{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the form field group."
    },
    "rule": {
      "$ref": "#/components/schemas/TemplateResponseDocumentFieldGroupRule"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "groupLabel": {
      "type": "string",
      "description": "Name of the group"
    },
    "requirement": {
      "type": "string",
      "description": "Examples: `require_0-1` `require_1` `require_1-ormore`\n\n- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).\n- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).\n- Radio groups require **at least** two fields per group."
    }
  },
  "x-internal": true,
  "description": "The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping)."
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "The horizontal offset in pixels for this form field."
    },
    "y": {
      "type": "integer",
      "description": "The vertical offset in pixels for this form field."
    },
    "name": {
      "type": "string",
      "description": "The name of the form field."
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string",
      "nullable": true,
      "description": "The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields."
    },
    "width": {
      "type": "integer",
      "description": "The width in pixels of this form field."
    },
    "api_id": {
      "type": "string",
      "description": "A unique id for the form field."
    },
    "height": {
      "type": "integer",
      "description": "The height in pixels of this form field."
    },
    "signer": {
      "type": "string",
      "description": "The signer of the Form Field."
    },
    "required": {
      "type": "boolean",
      "description": "Boolean showing whether or not this field is required."
    }
  },
  "x-internal": true,
  "description": "An array of Form Field objects containing the name and type of each named field.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/TemplateResponseDocumentFormFieldText",
      "radio": "#/components/schemas/TemplateResponseDocumentFormFieldRadio",
      "checkbox": "#/components/schemas/TemplateResponseDocumentFormFieldCheckbox",
      "dropdown": "#/components/schemas/TemplateResponseDocumentFormFieldDropdown",
      "initials": "#/components/schemas/TemplateResponseDocumentFormFieldInitials",
      "hyperlink": "#/components/schemas/TemplateResponseDocumentFormFieldHyperlink",
      "signature": "#/components/schemas/TemplateResponseDocumentFormFieldSignature",
      "date_signed": "#/components/schemas/TemplateResponseDocumentFormFieldDateSigned"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "hyperlink",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        },
        "fontFamily": {
          "type": "string",
          "description": "Font family used in this form field's text."
        },
        "isMultiline": {
          "type": "boolean",
          "description": "Whether this form field is multiline text."
        },
        "avg_text_length": {
          "$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
        },
        "originalFontSize": {
          "type": "integer",
          "description": "Original font size used in this form field's text."
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type",
    "group"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        },
        "fontFamily": {
          "type": "string",
          "description": "Font family used in this form field's text."
        },
        "isMultiline": {
          "type": "boolean",
          "description": "Whether this form field is multiline text."
        },
        "avg_text_length": {
          "$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
        },
        "validation_type": {
          "enum": [
            "numbers_only",
            "letters_only",
            "phone_number",
            "bank_routing_number",
            "bank_account_number",
            "email_address",
            "zip_code",
            "social_security_number",
            "employer_identification_number",
            "custom_regex"
          ],
          "type": "string",
          "nullable": true,
          "description": "Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values."
        },
        "originalFontSize": {
          "type": "integer",
          "description": "Original font size used in this form field's text."
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "The horizontal offset in pixels for this static field."
    },
    "y": {
      "type": "integer",
      "description": "The vertical offset in pixels for this static field."
    },
    "name": {
      "type": "string",
      "description": "The name of the static field."
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string",
      "nullable": true,
      "description": "The name of the group this field is in. If this field is not a group, this defaults to `null`."
    },
    "width": {
      "type": "integer",
      "description": "The width in pixels of this static field."
    },
    "api_id": {
      "type": "string",
      "description": "A unique id for the static field."
    },
    "height": {
      "type": "integer",
      "description": "The height in pixels of this static field."
    },
    "signer": {
      "type": "string",
      "default": "me_now",
      "description": "The signer of the Static Field."
    },
    "required": {
      "type": "boolean",
      "description": "Boolean showing whether or not this field is required."
    }
  },
  "x-internal": true,
  "description": "An array describing static overlay fields. **Note** only available for certain subscriptions.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/TemplateResponseDocumentStaticFieldText",
      "radio": "#/components/schemas/TemplateResponseDocumentStaticFieldRadio",
      "checkbox": "#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox",
      "dropdown": "#/components/schemas/TemplateResponseDocumentStaticFieldDropdown",
      "initials": "#/components/schemas/TemplateResponseDocumentStaticFieldInitials",
      "hyperlink": "#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink",
      "signature": "#/components/schemas/TemplateResponseDocumentStaticFieldSignature",
      "date_signed": "#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "hyperlink",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "properties": {
    "num_lines": {
      "type": "integer",
      "description": "Number of lines."
    },
    "num_chars_per_line": {
      "type": "integer",
      "description": "Number of characters per line."
    }
  },
  "x-internal": true,
  "description": "Average text length in this field."
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Role."
    },
    "order": {
      "type": "integer",
      "description": "If signer order is assigned this is the 0-based index for this role."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to use for the template.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The new default template email message."
    },
    "subject": {
      "type": "string",
      "maxLength": 100,
      "description": "The new default template email subject."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to update this template."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    }
  }
}

{
  "type": "object",
  "properties": {
    "template": {
      "$ref": "#/components/schemas/TemplateUpdateFilesResponseTemplate"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "deprecated": true,
      "description": "A list of warnings."
    },
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    }
  },
  "x-internal": true,
  "description": "Contains template id"
}

{
  "type": "object",
  "required": [
    "client_id",
    "requester_email_address"
  ],
  "properties": {
    "type": {
      "enum": [
        "send_document",
        "request_signature"
      ],
      "type": "string",
      "default": "request_signature",
      "description": "The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubUnclaimedDraftSigner"
      },
      "description": "Add Signers to your Unclaimed Draft Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "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.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "allow_ccs": {
      "type": "boolean",
      "default": true,
      "description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.\n\n**Note**: This does not correspond to the **expires_at** returned in the response."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "skip_me_now": {
      "type": "boolean",
      "default": false,
      "description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
    },
    "hold_request": {
      "type": "boolean",
      "default": false,
      "description": "The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](https://raw.githubusercontent.com) the request from hold when ready to send. Defaults to `false`."
    },
    "show_preview": {
      "type": "boolean",
      "description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "force_signer_page": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the signers."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "description": "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`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "default": false,
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
      },
      "description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "client_id",
    "requester_email_address",
    "template_ids"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.\n\n**files** or **file_urls[]** is required, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubUnclaimedDraftTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "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.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "allow_ccs": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.\n\n**files** or **file_urls[]** is required, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "skip_me_now": {
      "type": "boolean",
      "default": false,
      "description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
    },
    "hold_request": {
      "type": "boolean",
      "default": false,
      "description": "The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](https://raw.githubusercontent.com) the request from hold when ready to send. Defaults to `false`."
    },
    "preview_only": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).\n\n- `preview_only=true`: Allows requesters to enable the preview only experience.\n- `preview_only=false`: Allows requesters to disable the preview only experience.\n\n**Note**: This parameter overwrites `show_preview=1` (if set)."
    },
    "show_preview": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "force_signer_roles": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "default": false,
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  }
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "send_document",
        "request_signature"
      ],
      "type": "string",
      "description": "The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubUnclaimedDraftSigner"
      },
      "description": "Add Signers to your Unclaimed Draft Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "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.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.\n\n**Note**: This does not correspond to the **expires_at** returned in the response."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "description": "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`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
      },
      "description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "unclaimed_draft": {
      "$ref": "#/components/schemas/UnclaimedDraftResponse"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    }
  }
}

{
  "type": "object",
  "properties": {
    "claim_url": {
      "type": "string",
      "description": "The URL to be used to claim this UnclaimedDraft."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test draft. Signature requests made from test drafts have no legal value."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the link expires."
    },
    "signature_request_id": {
      "type": "string",
      "nullable": true,
      "description": "The ID of the signature request that is represented by this UnclaimedDraft."
    },
    "signing_redirect_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "requesting_redirect_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.)."
    }
  },
  "x-internal": true,
  "description": "A group of documents that a user can take ownership of via the claim URL."
}

{
  "type": "object",
  "required": [
    "warning_msg",
    "warning_name"
  ],
  "properties": {
    "warning_msg": {
      "type": "string",
      "description": "Warning message"
    },
    "warning_name": {
      "type": "string",
      "description": "Warning name"
    }
  },
  "description": "A list of warnings."
}