Updates sender fields for an envelope.

This method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state.

Use the DocumentGeneration::getEnvelopeDocGenFormFields response to retrieve the list of sender fields for your envelope. Use that list to build the request for this method. For each field, specify the field name and the value to populate.

For example, your request body might look like this:

{
  "docGenFormFields": [
    {
      "documentId": "bf3202e1-xxxx-xxxx-xxxx-af4f41366879",
      "docGenFormFieldList": [
        {
          "name": "Candidate_Name",
          "value": "Peggy Olson"
        },
        {
          "name": "Job_Title",
          "value": "Technical Writer"
        },
        {
          "name": "Manager_Name",
          "value": "Donald Draper"
        },
        {
          "name": "Start_Date",
          "value": "1960-02-28"
        },
        {
          "name": "Salary",
          "value": "3380"
        }
      ]
    }
  ]
}

Important notes

• If update_docgen_formfields_only is false (the default), the documentId changes after the update.
• This endpoint does not validate number, date, or select data field values. The request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values.

Related topics

• Learn about document generation in the eSignature concepts guide.
• See this method in use in your preferred coding language.