Dropbox · Schema

SignatureRequestSendWithTemplateRequest

Documents

Properties

Name Type Description
template_ids array _t__SignatureRequestSendWithTemplate::TEMPLATE_IDS
allow_decline boolean _t__SignatureRequestSendWithTemplate::ALLOW_DECLINE
ccs array _t__Sub::CC::DESCRIPTION
client_id string _t__SignatureRequestSendWithTemplate::CLIENT_ID
custom_fields array _t__Sub::CustomField::TEMPLATE
files array _t__SignatureRequestSendWithTemplate::FILES
file_urls array _t__SignatureRequestSendWithTemplate::FILE_URLS
is_qualified_signature boolean _t__SignatureRequestSendWithTemplate::IS_QUALIFIED_SIGNATURE
is_eid boolean _t__SignatureRequestSendWithTemplate::IS_EID
message string _t__SignatureRequestSendWithTemplate::MESSAGE
metadata object _t__Sub::Metadata::DESCRIPTION
signers array _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION
signing_options object
signing_redirect_url string _t__SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL
subject string _t__SignatureRequestSendWithTemplate::SUBJECT
test_mode boolean _t__SignatureRequestSendWithTemplate::TEST_MODE
title string _t__SignatureRequestSendWithTemplate::TITLE
View JSON Schema on GitHub

JSON Schema

dropbox-signaturerequestsendwithtemplaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignatureRequestSendWithTemplateRequest",
  "title": "SignatureRequestSendWithTemplateRequest",
  "description": "",
  "required": [
    "signers",
    "template_ids"
  ],
  "properties": {
    "template_ids": {
      "description": "_t__SignatureRequestSendWithTemplate::TEMPLATE_IDS",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allow_decline": {
      "description": "_t__SignatureRequestSendWithTemplate::ALLOW_DECLINE",
      "type": "boolean",
      "default": false
    },
    "ccs": {
      "description": "_t__Sub::CC::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      }
    },
    "client_id": {
      "description": "_t__SignatureRequestSendWithTemplate::CLIENT_ID",
      "type": "string"
    },
    "custom_fields": {
      "description": "_t__Sub::CustomField::TEMPLATE",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      }
    },
    "files": {
      "description": "_t__SignatureRequestSendWithTemplate::FILES",
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      }
    },
    "file_urls": {
      "description": "_t__SignatureRequestSendWithTemplate::FILE_URLS",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "is_qualified_signature": {
      "description": "_t__SignatureRequestSendWithTemplate::IS_QUALIFIED_SIGNATURE",
      "type": "boolean",
      "default": false,
      "deprecated": true,
      "x-hideOn": "doc"
    },
    "is_eid": {
      "description": "_t__SignatureRequestSendWithTemplate::IS_EID",
      "type": "boolean",
      "default": false
    },
    "message": {
      "description": "_t__SignatureRequestSendWithTemplate::MESSAGE",
      "type": "string",
      "maxLength": 5000
    },
    "metadata": {
      "description": "_t__Sub::Metadata::DESCRIPTION",
      "type": "object",
      "maxItems": 10,
      "additionalProperties": {}
    },
    "signers": {
      "description": "_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      }
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "signing_redirect_url": {
      "description": "_t__SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL",
      "type": "string"
    },
    "subject": {
      "description": "_t__SignatureRequestSendWithTemplate::SUBJECT",
      "type": "string",
      "maxLength": 255
    },
    "test_mode": {
      "description": "_t__SignatureRequestSendWithTemplate::TEST_MODE",
      "type": "boolean",
      "default": false
    },
    "title": {
      "description": "_t__SignatureRequestSendWithTemplate::TITLE",
      "type": "string",
      "maxLength": 255
    }
  },
  "type": "object"
}