Docusign · Schema

EnvelopeDefinition

The envelope definition object that contains all the properties needed to create and send an envelope.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
emailSubject	string	The subject line of the email sent to recipients.
emailBlurb	string	The body text of the email sent to recipients.
status	string	The envelope status. Set to "sent" to send the envelope immediately, or "created" to save as a draft.
templateId	string	The ID of a template to use as the basis for the envelope. When specified, the template's documents, recipients, and tabs are merged with any specified in the request.
templateRoles	array	Template role assignments that map recipients to template roles when using a templateId.
documents	array	The documents to include in the envelope.
compositeTemplates	array	An array of composite template objects that combine server templates and inline templates for complex workflows.
brandId	string	The ID of the brand to apply to the envelope.
envelopeIdStamping	string	When true, the envelope ID is stamped in the document margins.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EnvelopeDefinition",
  "type": "object",
  "description": "The envelope definition object that contains all the properties needed to create and send an envelope.",
  "properties": {
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email sent to recipients."
    },
    "emailBlurb": {
      "type": "string",
      "description": "The body text of the email sent to recipients."
    },
    "status": {
      "type": "string",
      "description": "The envelope status. Set to \"sent\" to send the envelope immediately, or \"created\" to save as a draft."
    },
    "templateId": {
      "type": "string",
      "description": "The ID of a template to use as the basis for the envelope. When specified, the template's documents, recipients, and tabs are merged with any specified in the request."
    },
    "templateRoles": {
      "type": "array",
      "description": "Template role assignments that map recipients to template roles when using a templateId."
    },
    "documents": {
      "type": "array",
      "description": "The documents to include in the envelope."
    },
    "compositeTemplates": {
      "type": "array",
      "description": "An array of composite template objects that combine server templates and inline templates for complex workflows."
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand to apply to the envelope."
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When true, the envelope ID is stamped in the document margins."
    }
  }
}