Docupilot · Schema

YouSignDelivery

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name Type Description
id integer
failure_email_recipients string
account integer
signers array
approvers array
followers array
reminder_settings object
name string
type string
success_callback_url string
success_callback_payload object
success_callback_headers object
last_used_on string
title string
email_custom_note string
delivery_mode string
ordered_signers boolean
timezone string
expiration_date string
custom_experience_id string
yousign_workspace_id string
audit_trail_locale string
enable_optional_signers boolean
View JSON Schema on GitHub

JSON Schema

app-YouSignDelivery.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "YouSignDelivery",
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "failure_email_recipients": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "account": {
      "type": "integer"
    },
    "signers": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "minLength": 2
          },
          "last_name": {
            "type": "string",
            "minLength": 2
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone_number": {
            "type": "string"
          },
          "locale": {
            "type": "string",
            "minLength": 2,
            "enum": [
              "en",
              "fr",
              "de",
              "it",
              "nl",
              "es",
              "pl"
            ]
          },
          "success_url": {
            "type": "string",
            "format": "uri"
          },
          "error_url": {
            "type": "string",
            "format": "uri"
          },
          "signature_authentication_mode": {
            "type": "string",
            "enum": [
              "otp_email",
              "otp_sms",
              "no_otp"
            ]
          },
          "signature_level": {
            "type": "string",
            "enum": [
              "electronic_signature",
              "advanced_electronic_signature",
              "electronic_signature_with_qualified_certificate",
              "qualified_electronic_signature_mode_1"
            ]
          },
          "order": {
            "type": "number"
          }
        },
        "required": [
          "first_name",
          "last_name",
          "email",
          "locale",
          "signature_level",
          "signature_authentication_mode"
        ]
      }
    },
    "approvers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 2,
            "enum": [
              "en",
              "fr",
              "de",
              "it",
              "nl",
              "es",
              "pl"
            ]
          },
          "first_name": {
            "type": "string",
            "minLength": 2
          },
          "last_name": {
            "type": "string",
            "minLength": 2
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone_number": {
            "type": "string"
          }
        },
        "required": [
          "locale",
          "first_name",
          "last_name",
          "email"
        ]
      },
      "nullable": true
    },
    "followers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string",
            "minLength": 2,
            "enum": [
              "en",
              "fr",
              "de",
              "it",
              "nl",
              "es",
              "pl"
            ]
          },
          "email": {
            "type": "string",
            "format": "email"
          }
        },
        "required": [
          "locale",
          "email"
        ]
      },
      "nullable": true
    },
    "reminder_settings": {
      "type": "object",
      "properties": {
        "interval_in_days": {
          "type": "number",
          "enum": [
            1,
            2,
            7,
            14
          ]
        },
        "max_occurrences": {
          "type": "number",
          "minimum": 1,
          "maximum": 10
        }
      },
      "required": [
        "interval_in_days",
        "max_occurrences"
      ],
      "nullable": 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
    },
    "title": {
      "type": "string",
      "maxLength": 256
    },
    "email_custom_note": {
      "type": "string",
      "nullable": true
    },
    "delivery_mode": {
      "enum": [
        "email"
      ],
      "type": "string"
    },
    "ordered_signers": {
      "type": "boolean"
    },
    "timezone": {
      "type": "string",
      "nullable": true,
      "maxLength": 100
    },
    "expiration_date": {
      "type": "string",
      "format": "date",
      "nullable": true
    },
    "custom_experience_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 256
    },
    "yousign_workspace_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 256
    },
    "audit_trail_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 256
    },
    "enable_optional_signers": {
      "type": "boolean"
    }
  },
  "required": [
    "account",
    "id",
    "name",
    "signers",
    "title"
  ]
}