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