Skip to navigation

EnvelopeFormData Resource

View as Markdown

The EnvelopeFormData resource provides methods that manage forms in an envelope.

Methods supported

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

EnvelopeFormData properties

PropertyTypeDescription
emailSubjectstringSpecifies the subject of the email that is sent to all recipients.

See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
envelopeIdstringThe envelope ID of the envelope status that failed to post.
formDataarray
prefillFormDataprefillFormData
recipientFormDataarray
sentDateTimestringThe UTC DateTime when the envelope was sent. Read only.
statusstringIndicates the envelope status. Valid values are:
  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.