Docupilot · Schema

SignatureDelivery

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name	Type	Description
id	integer
failure_email_recipients	string
signers	array
use_default_reminders	boolean
expiry	integer
first_reminder	integer
reminder_frequency	integer
warn_before	integer
sender	integer
sender_mode	string
folder_name	string
name	string
type	string
success_callback_url	string
success_callback_payload	object
success_callback_headers	object
last_used_on	string
subject	string
message	string
cc	array
sequenced_signing	boolean
enable_optional_signers	boolean
folder	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SignatureDelivery",
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "failure_email_recipients": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "signers": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "order": {
            "type": "number"
          },
          "name": {
            "type": "string",
            "minLength": 3
          },
          "email": {
            "type": "string",
            "format": "email"
          }
        },
        "required": [
          "id",
          "name",
          "email"
        ]
      }
    },
    "use_default_reminders": {
      "type": "boolean",
      "default": false
    },
    "expiry": {
      "type": "integer",
      "nullable": true
    },
    "first_reminder": {
      "type": "integer",
      "nullable": true
    },
    "reminder_frequency": {
      "type": "integer",
      "nullable": true
    },
    "warn_before": {
      "type": "integer",
      "nullable": true
    },
    "sender": {
      "type": "integer",
      "nullable": true
    },
    "sender_mode": {
      "enum": [
        "fixed",
        "smart"
      ],
      "type": "string"
    },
    "folder_name": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "type": {
      "enum": [
        "webhook",
        "azure_blob_storage",
        "box_drive",
        "signature",
        "docu_sign",
        "sign_now",
        "zoho_crm",
        "dropbox",
        "google_drive",
        "podio",
        "one_drive",
        "sharepoint",
        "eversign",
        "hellosign",
        "aws_s3",
        "signable",
        "yousign",
        "email",
        "sftp"
      ],
      "type": "string"
    },
    "success_callback_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "success_callback_payload": {
      "type": "object",
      "additionalProperties": {},
      "nullable": true
    },
    "success_callback_headers": {
      "type": "object",
      "additionalProperties": {},
      "nullable": true
    },
    "last_used_on": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "subject": {
      "type": "string",
      "nullable": true
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "sequenced_signing": {
      "type": "boolean"
    },
    "enable_optional_signers": {
      "type": "boolean"
    },
    "folder": {
      "type": "integer",
      "nullable": true
    }
  },
  "required": [
    "folder_name",
    "id",
    "name",
    "signers"
  ]
}