Get sender fields for envelope

GET

/v2.1/accounts/:accountId/envelopes/:envelopeId/docGenFormFields

GET

/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/docGenFormFields

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/docGenFormFields \
     -H "Authorization: Bearer <apiKey>"

{
  "docGenFormFields": [
    {
      "docGenConditionalRules": [
        {
          "conditionalOperations": [
            {}
          ],
          "conditionalRuleEffect": "sample string 1",
          "conditionalRuleEffectFields": [
            "sample string 1"
          ],
          "conditionalRuleOperator": "sample string 2"
        }
      ],
      "docGenDocumentStatus": "sample string 1",
      "docGenErrors": [
        {
          "errorCode": "sample string 1",
          "message": "sample string 2",
          "tagIdentifier": "sample string 3"
        }
      ],
      "docGenFormFieldList": [
        {
          "children": [
            {}
          ],
          "connectedObjectDetails": {
            "recordId": "sample string 1"
          },
          "defaultValue": "sample string 1",
          "description": "sample string 2",
          "format": {
            "expression": "sample string 1",
            "locale": "sample string 2"
          },
          "fullyQualifiedPath": "sample string 3",
          "hidden": true,
          "label": "sample string 4",
          "name": "sample string 5",
          "options": [
            {
              "description": "sample string 1",
              "label": "sample string 2",
              "selected": "sample string 3",
              "value": "sample string 4"
            }
          ],
          "order": "sample string 6",
          "predefinedValidation": "sample string 7",
          "readOnly": true,
          "required": "sample string 8",
          "rowValues": [
            {
              "docGenFormFieldList": [
                {}
              ]
            }
          ],
          "type": "sample string 9",
          "validation": {
            "errorMessage": "sample string 1",
            "expression": "sample string 2"
          },
          "value": "sample string 10"
        }
      ],
      "documentId": "sample string 2"
    }
  ],
  "errorDetails": {
    "errorCode": "sample string 1",
    "message": "sample string 2"
  }
}

Given an envelopeId, this method returns the sender fields found in that envelope’s documents. After you retrieve the sender fields, use the DocumentGeneration::updateEnvelopeDocGenFormFields method to populate the fields.

If the specified envelope does not contain a document with sender fields, the method will return success (200) and an empty object ({}) in the response.

Next steps

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

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