Docusign

Docusign EnvelopeDocumentFields API

The EnvelopeDocumentFields resource provides methods that allow you to manage custom fields on a document. You can create custom versions of standard fields that combine of field properties, such as font type or size, or a validation setting. Note: Some advanced features and options are supported only in certain DocuSign plans. Your account plan might not support some options discussed in this help topic. For more information about which options are available for your account, check your account plan or contact your Account Manager.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Get custom fields on an envelope document · Docusign Gets the custom document fields from an existing envelope document #

Ask an LLM

“What custom document fields are set on a document in a sent envelope?”

“Can I read the metadata fields attached to an envelope document?”

Tell an agent

Get the custom fields on document {document} of envelope {envelope} in account {account}.

Show document fields for envelope {envelope}, document {document}, account {account}.

PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Update custom fields on an envelope document · Docusign Updates existing custom document fields in an existing envelope… #

Ask an LLM

“How do I change the value of an existing custom field on an envelope document?”

“Can document field values be edited after the envelope is created?”

Tell an agent

Update fields {fields} on document {document} in envelope {envelope}, account {account}.

Change existing document field values on envelope {envelope} document {document} in account {account}.

POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Add custom fields to an envelope document · Docusign Creates custom document fields in an existing envelope document #

Ask an LLM

“Can I attach new custom metadata fields to a document in an envelope?”

“How do I add document fields to an envelope that already exists?”

Tell an agent

Add fields {fields} to document {document} in envelope {envelope}, account {account}.

Create new custom fields on envelope {envelope} document {document} for account {account}.

DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Remove custom fields from an envelope document · Docusign Deletes custom document fields from an existing envelope document #

Ask an LLM

“Can I delete custom fields from a document in an envelope?”

“How do I clear metadata fields off an envelope document?”

Tell an agent destructive · confirm first

Delete fields {fields} from document {document} in envelope {envelope}, account {account}.

Remove custom document fields from envelope {envelope} document {document} on account {account}.

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Gets the custom document fields from an existing envelope document #

PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Updates existing custom document fields in an existing envelope document #

POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Creates custom document fields in an existing envelope document #

DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Deletes custom document fields from an existing envelope document #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/docusign:docusign-envelopedocumentfields-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Docusign Envelope Document Fields API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeDocumentFields across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeDocumentFields
  description: 'The EnvelopeDocumentFields resource provides methods that allow you to manage custom fields on a document.


    You can create custom versions of standard fields that combine of field properties, such as font type or size, or a validation setting.


    Note: Some advanced features and options are supported only in certain DocuSign plans. Your account plan might not support some options discussed in this help topic. For more information about which options are available for your account, check your account plan or contact your Account Manager.'
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields:
    get:
      tags:
      - EnvelopeDocumentFields
      summary: Docusign Gets the custom document fields from an existing envelope document
      description: Retrieves the custom document field information from an existing envelope document.
      operationId: DocumentFields_GetDocumentFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: The ID of the document being accessed.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listDocumentFields
      x-ds-method: list
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeDocumentFields
      summary: Docusign Updates existing custom document fields in an existing envelope…
      description: Updates existing custom document fields in an existing envelope document.
      operationId: DocumentFields_PutDocumentFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: The ID of the document being accessed.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateDocumentFields
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeDocumentFields
    post:
      tags:
      - EnvelopeDocumentFields
      summary: Docusign Creates custom document fields in an existing envelope document
      description: Creates custom document fields in an existing envelope document.
      operationId: DocumentFields_PostDocumentFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: The ID of the document being accessed.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createDocumentFields
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeDocumentFields
    delete:
      tags:
      - EnvelopeDocumentFields
      summary: Docusign Deletes custom document fields from an existing envelope document
      description: Deletes custom document fields from an existing envelope document.
      operationId: DocumentFields_DeleteDocumentFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: The ID of the document being accessed.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteDocumentFields
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeDocumentFields
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields:
    parameters: []
    get:
      tags:
      - EnvelopeDocumentFields
      summary: Gets the custom document fields from an existing envelope document
      description: Retrieves the custom document field information from an existing envelope document.
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdDocumentsByDocumentIdFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: 'The unique ID of the document within the envelope.


          Unlike other IDs in the eSignature API,

          you specify the `documentId` yourself.

          Typically the first document has the ID

          `1`, the second document `2`, and so on,

          but you can use any numbering scheme

          that fits within a 32-bit signed integer

          (1 through 2147483647).



          Tab objects have a `documentId` property

          that specifies the document on which to place

          the tab.

          '
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listDocumentFields
      x-ds-method: list
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_GetDocumentFields
    put:
      tags:
      - EnvelopeDocumentFields
      summary: Updates existing custom document fields in an existing envelope document
      description: Updates existing custom document fields in an existing envelope document.
      operationId: putV21AccountsByAccountIdEnvelopesByEnvelopeIdDocumentsByDocumentIdFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: 'The unique ID of the document within the envelope.


          Unlike other IDs in the eSignature API,

          you specify the `documentId` yourself.

          Typically the first document has the ID

          `1`, the second document `2`, and so on,

          but you can use any numbering scheme

          that fits within a 32-bit signed integer

          (1 through 2147483647).



          Tab objects have a `documentId` property

          that specifies the document on which to place

          the tab.

          '
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateDocumentFields
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_PutDocumentFields
    post:
      tags:
      - EnvelopeDocumentFields
      summary: Creates custom document fields in an existing envelope document
      description: Creates custom document fields in an existing envelope document.
      operationId: postV21AccountsByAccountIdEnvelopesByEnvelopeIdDocumentsByDocumentIdFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: 'The unique ID of the document within the envelope.


          Unlike other IDs in the eSignature API,

          you specify the `documentId` yourself.

          Typically the first document has the ID

          `1`, the second document `2`, and so on,

          but you can use any numbering scheme

          that fits within a 32-bit signed integer

          (1 through 2147483647).



          Tab objects have a `documentId` property

          that specifies the document on which to place

          the tab.

          '
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: createDocumentFields
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_PostDocumentFields
    delete:
      tags:
      - EnvelopeDocumentFields
      summary: Deletes custom document fields from an existing envelope document
      description: Deletes custom document fields from an existing envelope document.
      operationId: deleteV21AccountsByAccountIdEnvelopesByEnvelopeIdDocumentsByDocumentIdFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: 'The unique ID of the document within the envelope.


          Unlike other IDs in the eSignature API,

          you specify the `documentId` yourself.

          Typically the first document has the ID

          `1`, the second document `2`, and so on,

          but you can use any numbering scheme

          that fits within a 32-bit signed integer

          (1 through 2147483647).



          Tab objects have a `documentId` property

          that specifies the document on which to place

          the tab.

          '
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDocumentFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteDocumentFields
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeDocumentFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_DeleteDocumentFields
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    nameValue:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        name:
          type: string
          description: The name or key of a name/value pair.
        originalValue:
          type: string
          description: 'The initial value of the tab when it was sent to the recipient. '
        value:
          type: string
          description: The value field of a name/value pair.
      description: ''
      x-ds-definition-name: nameValue
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    EnvelopeDocumentFields:
      type: object
      properties:
        documentFields:
          type: array
          description: "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* name - A string that can be a maximum of 50 characters. \n* value - A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n"
          items:
            $ref: '#/components/schemas/nameValue'
      description: Envelope document fields
      x-ds-definition-name: documentFieldsInformation
      x-ds-category: Envelopes
      x-ds-order: '60'
      x-ms-summary: Envelope document fields
    nameValue_2:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        name:
          description: The name of the item.
          type: string
        originalValue:
          description: The initial value of the item.
          type: string
        value:
          description: The current value of the item.
          type: string
      description: A name-value pair that describes an item and provides a value for the item.
      x-ds-definition-name: nameValue
      x-ms-summary: A name-value pair that describes an item and provides a value for the item.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    EnvelopeDocumentFields_2:
      type: object
      properties:
        documentFields:
          description: "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: \n\n* name - A string that can be a maximum of 50 characters. \n* value - A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n"
          type: array
          items:
            $ref: '#/components/schemas/nameValue_2'
      x-ds-definition-name: documentFieldsInformation
      description: Envelope document fields
      x-ds-category: Envelopes
      x-ds-order: '60'
      x-ms-summary: Envelope document fields
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'

Docusign EnvelopeDocumentFields API

Operations 8

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification