Dropbox · Schema

TemplateCreateRequest

Documents

Properties

Name Type Description
files array _t__TemplateCreate::FILES
file_urls array _t__TemplateCreate::FILE_URLS
allow_reassign boolean _t__TemplateCreate::ALLOW_REASSIGN
attachments array _t__SubAttachment::LIST_DESCRIPTION
cc_roles array _t__TemplateCreate::CC_ROLES
client_id string _t__TemplateCreate::CLIENT_ID
field_options object
form_field_groups array _t__Sub::FormFieldGroup::DESCRIPTION
form_field_rules array _t__Sub::FormFieldRule::DESCRIPTION
form_fields_per_document array _t__Sub::FormFieldsPerDocument::DESCRIPTION
merge_fields array _t__TemplateCreate::MERGE_FIELDS
message string _t__TemplateCreate::MESSAGE
metadata object _t__Sub::Metadata::DESCRIPTION
signer_roles array _t__TemplateCreate::SIGNER_ROLES
subject string _t__TemplateCreate::SUBJECT
test_mode boolean _t__TemplateCreate::TEST_MODE
title string _t__TemplateCreate::TITLE
use_preexisting_fields boolean _t__TemplateCreate::USE_PREEXISTING_FIELDS
View JSON Schema on GitHub

JSON Schema

dropbox-templatecreaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TemplateCreateRequest",
  "title": "TemplateCreateRequest",
  "required": [
    "signer_roles",
    "form_fields_per_document"
  ],
  "properties": {
    "files": {
      "description": "_t__TemplateCreate::FILES",
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      }
    },
    "file_urls": {
      "description": "_t__TemplateCreate::FILE_URLS",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allow_reassign": {
      "description": "_t__TemplateCreate::ALLOW_REASSIGN",
      "type": "boolean",
      "default": false
    },
    "attachments": {
      "description": "_t__SubAttachment::LIST_DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      }
    },
    "cc_roles": {
      "description": "_t__TemplateCreate::CC_ROLES",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "client_id": {
      "description": "_t__TemplateCreate::CLIENT_ID",
      "type": "string"
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "form_field_groups": {
      "description": "_t__Sub::FormFieldGroup::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      }
    },
    "form_field_rules": {
      "description": "_t__Sub::FormFieldRule::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      }
    },
    "form_fields_per_document": {
      "description": "_t__Sub::FormFieldsPerDocument::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
      }
    },
    "merge_fields": {
      "description": "_t__TemplateCreate::MERGE_FIELDS",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubMergeField"
      }
    },
    "message": {
      "description": "_t__TemplateCreate::MESSAGE",
      "type": "string",
      "maxLength": 5000
    },
    "metadata": {
      "description": "_t__Sub::Metadata::DESCRIPTION",
      "type": "object",
      "maxItems": 10,
      "additionalProperties": {}
    },
    "signer_roles": {
      "description": "_t__TemplateCreate::SIGNER_ROLES",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubTemplateRole"
      }
    },
    "subject": {
      "description": "_t__TemplateCreate::SUBJECT",
      "type": "string",
      "maxLength": 200
    },
    "test_mode": {
      "description": "_t__TemplateCreate::TEST_MODE",
      "type": "boolean",
      "default": false
    },
    "title": {
      "description": "_t__TemplateCreate::TITLE",
      "type": "string"
    },
    "use_preexisting_fields": {
      "description": "_t__TemplateCreate::USE_PREEXISTING_FIELDS",
      "type": "boolean",
      "default": false
    }
  },
  "type": "object"
}