Dropbox · Schema

SignatureRequestCreateEmbeddedRequest

Documents

Properties

Name Type Description
files array _t__SignatureRequestCreateEmbedded::FILES
file_urls array _t__SignatureRequestCreateEmbedded::FILE_URLS
signers array _t__Sub::SignatureRequestSigner::DESCRIPTION
grouped_signers array _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION
allow_decline boolean _t__SignatureRequestCreateEmbedded::ALLOW_DECLINE
allow_reassign boolean _t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN
attachments array _t__SubAttachment::LIST_DESCRIPTION
cc_email_addresses array _t__SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES
client_id string _t__SignatureRequestCreateEmbedded::CLIENT_ID
custom_fields array _t__Sub::CustomField::DESCRIPTION
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
hide_text_tags boolean _t__SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS
message string _t__SignatureRequestCreateEmbedded::MESSAGE
metadata object _t__Sub::Metadata::DESCRIPTION
signing_options object
subject string _t__SignatureRequestCreateEmbedded::SUBJECT
test_mode boolean _t__SignatureRequestCreateEmbedded::TEST_MODE
title string _t__SignatureRequestCreateEmbedded::TITLE
use_text_tags boolean _t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS
populate_auto_fill_fields boolean _t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS
expires_at integer _t__SignatureRequestCreateEmbedded::EXPIRES_AT
View JSON Schema on GitHub

JSON Schema

dropbox-signaturerequestcreateembeddedrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignatureRequestCreateEmbeddedRequest",
  "title": "SignatureRequestCreateEmbeddedRequest",
  "required": [
    "client_id"
  ],
  "properties": {
    "files": {
      "description": "_t__SignatureRequestCreateEmbedded::FILES",
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      }
    },
    "file_urls": {
      "description": "_t__SignatureRequestCreateEmbedded::FILE_URLS",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "signers": {
      "description": "_t__Sub::SignatureRequestSigner::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      }
    },
    "grouped_signers": {
      "description": "_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestGroupedSigners"
      }
    },
    "allow_decline": {
      "description": "_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE",
      "type": "boolean",
      "default": false
    },
    "allow_reassign": {
      "description": "_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN",
      "type": "boolean",
      "default": false
    },
    "attachments": {
      "description": "_t__SubAttachment::LIST_DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      }
    },
    "cc_email_addresses": {
      "description": "_t__SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES",
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      }
    },
    "client_id": {
      "description": "_t__SignatureRequestCreateEmbedded::CLIENT_ID",
      "type": "string"
    },
    "custom_fields": {
      "description": "_t__Sub::CustomField::DESCRIPTION",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      }
    },
    "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"
      }
    },
    "hide_text_tags": {
      "description": "_t__SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS",
      "type": "boolean",
      "default": false
    },
    "message": {
      "description": "_t__SignatureRequestCreateEmbedded::MESSAGE",
      "type": "string",
      "maxLength": 5000
    },
    "metadata": {
      "description": "_t__Sub::Metadata::DESCRIPTION",
      "type": "object",
      "maxItems": 10,
      "additionalProperties": {}
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "subject": {
      "description": "_t__SignatureRequestCreateEmbedded::SUBJECT",
      "type": "string",
      "maxLength": 255
    },
    "test_mode": {
      "description": "_t__SignatureRequestCreateEmbedded::TEST_MODE",
      "type": "boolean",
      "default": false
    },
    "title": {
      "description": "_t__SignatureRequestCreateEmbedded::TITLE",
      "type": "string",
      "maxLength": 255
    },
    "use_text_tags": {
      "description": "_t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS",
      "type": "boolean",
      "default": false
    },
    "populate_auto_fill_fields": {
      "description": "_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS",
      "type": "boolean",
      "default": false
    },
    "expires_at": {
      "description": "_t__SignatureRequestCreateEmbedded::EXPIRES_AT",
      "type": "integer",
      "nullable": true
    }
  },
  "type": "object"
}