Docupilot · Schema

EnvelopeDetails

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name	Type	Description
id	integer
documents	array
recipients	array
envelope_id	string
sn_envelope_id	string
sn_invite_id	string
name	string
status	string
cc	array
sequenced_signing	boolean
expiry	string
first_reminder	string	ex: P3D to send first reminders after 3 days of sending invite
reminder_frequency	string	ex: P3D to send follow up reminders every 3 days
warn_before	string
created_at	string
updated_at	string
completed_at	string
deleted_at	string
archived_at	string
declined_at	string
voided_at	string
reason	string	ex: Reason for Declining or Voiding provided by signer or sender respectively
audit_log_doc	string
source	integer
workspace	integer
sender	integer
voided_by	integer
updated_by	integer
folder	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "EnvelopeDetails",
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EnvelopeDocuments"
      }
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EnvelopeRecipient"
      }
    },
    "envelope_id": {
      "type": "string",
      "readOnly": true
    },
    "sn_envelope_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "sn_invite_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "status": {
      "enum": [
        "created",
        "pending",
        "voided",
        "declined",
        "completed"
      ],
      "type": "string"
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "sequenced_signing": {
      "type": "boolean"
    },
    "expiry": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "first_reminder": {
      "type": "string",
      "nullable": true,
      "description": "ex: P3D to send first reminders after 3 days of sending invite"
    },
    "reminder_frequency": {
      "type": "string",
      "nullable": true,
      "description": "ex: P3D to send follow up reminders every 3 days"
    },
    "warn_before": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "archived_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "declined_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "voided_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "description": "ex: Reason for Declining or Voiding provided by signer or sender respectively",
      "minLength": 4,
      "maxLength": 500
    },
    "audit_log_doc": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "source": {
      "enum": [
        1,
        2
      ],
      "type": "integer",
      "minimum": -2147483648,
      "maximum": 2147483647
    },
    "workspace": {
      "type": "integer"
    },
    "sender": {
      "type": "integer"
    },
    "voided_by": {
      "type": "integer",
      "nullable": true
    },
    "updated_by": {
      "type": "integer",
      "nullable": true
    },
    "folder": {
      "type": "integer",
      "nullable": true
    }
  },
  "required": [
    "created_at",
    "documents",
    "envelope_id",
    "id",
    "name",
    "recipients",
    "sender",
    "updated_at",
    "workspace"
  ]
}