Skip to navigation

EnvelopeFormData Resource

View as Markdown

The EnvelopeFormData resource provides a method for downloading the data that users have entered into a form associated with an envelope.

Methods supported

MethodDescription
getGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data
Returns envelope tab data for an existing envelope.

EnvelopeFormData properties

PropertyTypeDescription
emailSubjectstringThe subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see Template Email Subject Merge Fields.

Note: The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.
envelopeIdstringThe ID of the envelope.
formDataarrayAn array of form data objects.
prefillFormDataprefillFormDataAn array of formDataItem objects for prefill tabs.
recipientFormDataarrayAn array of form data objects that are associated with specific recipients.
sentDateTimestringThe UTC DateTime when the envelope was sent. This property is read-only.
statusstringIndicates the envelope status. Valid values are:
  • completed: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
  • created: The envelope is created as a draft. It can be modified and sent later.
  • declined: The envelope has been declined by the recipients.
  • delivered: The envelope has been delivered to the recipients.
  • sent: The envelope will be sent to the recipients after the envelope is created.
  • signed: The envelope has been signed by the recipients.
  • voided: The envelope is no longer valid and recipients cannot access or sign the envelope.