Skip to navigation
Docusign eSignature REST APIEnvelopesDocumentGeneration

Update sender fields for envelope

View as Markdown

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.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

envelopeIdstringRequired

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

update_docgen_formfields_onlystringOptional

When false or omitted, the documents are updated.

When true, only the form fields are updated. The documents are unchanged. This option is used by integrators to save form field values without merging.

Request

This endpoint expects an object: docGenFormFieldRequest

docGenFormFieldslist of objectsOptional

A list of docGenFormFields objects.

Response

Successful response.
docGenFormFieldslist of objectsOptional

A list of docGenFormFields objects.

errorDetailsobjectOptional
This object describes errors that occur. It is only valid for responses, and ignored in requests.

Errors

400
Bad Request Error