Docupilot · Schema

DocuSignDelivery

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name Type Description
id integer
failure_email_recipients string
account integer
custom_tags object
signers array
reminder_settings object
overwrite_account_defaults boolean
name string
type string
success_callback_url string
success_callback_payload object
success_callback_headers object
last_used_on string
subject string
message string
fullname_anchor_tags boolean
sequenced_signing boolean
expire_after integer
enable_optional_signers boolean
api_version string
folder_id string
folder_name string
allow_reassign boolean
View JSON Schema on GitHub

JSON Schema

app-DocuSignDelivery.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DocuSignDelivery",
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "failure_email_recipients": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "account": {
      "type": "integer"
    },
    "custom_tags": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      },
      "nullable": true
    },
    "signers": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string"
          },
          "recipient_type": {
            "type": "string",
            "enum": [
              "signer",
              "agent",
              "cc",
              "editor"
            ]
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "is_email_delivery": {
            "type": "boolean"
          },
          "is_sms_delivery": {
            "type": "boolean"
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "minLength": 5
          },
          "country_code": {
            "type": "string"
          },
          "phone_number": {
            "type": "string"
          }
        },
        "required": [
          "recipient_type",
          "name",
          "is_email_delivery",
          "is_sms_delivery"
        ]
      }
    },
    "reminder_settings": {
      "type": "object",
      "nullable": true,
      "properties": {
        "reminder_delay": {
          "type": "number"
        },
        "reminder_frequency": {
          "type": "number"
        }
      },
      "required": [
        "reminder_delay",
        "reminder_frequency"
      ]
    },
    "overwrite_account_defaults": {
      "type": "boolean",
      "default": false
    },
    "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
    },
    "fullname_anchor_tags": {
      "type": "boolean"
    },
    "sequenced_signing": {
      "type": "boolean"
    },
    "expire_after": {
      "type": "integer",
      "maximum": 2147483647,
      "minimum": -2147483648,
      "nullable": true
    },
    "enable_optional_signers": {
      "type": "boolean"
    },
    "api_version": {
      "enum": [
        "2.0",
        "2.1"
      ],
      "type": "string",
      "readOnly": true
    },
    "folder_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 52
    },
    "folder_name": {
      "type": "string",
      "nullable": true
    },
    "allow_reassign": {
      "type": "boolean"
    }
  },
  "required": [
    "account",
    "api_version",
    "id",
    "name",
    "signers"
  ]
}