Docusign

Docusign EnvelopeCustomFields API

The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope. Custom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

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}/custom_fields Get custom fields on an envelope · Docusign Gets the custom field information for the specified envelope #

Ask an LLM

“What custom field values were recorded on an envelope?”

“Can I read the text and list custom fields of a specific envelope?”

Tell an agent

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

Show custom field values for envelope {envelope}.

PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Update existing envelope custom fields · Docusign Updates envelope custom fields in an envelope #

Ask an LLM

“How do I change a custom field value on an in-process envelope?”

“Can I edit the custom fields on a draft envelope?”

Tell an agent

Update the text custom fields on envelope {envelope} in account {account} to {textCustomFields}.

Change list custom field values on envelope {envelope} to {listCustomFields}.

POST /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Add custom fields to an envelope · Docusign Updates envelope custom fields for an envelope #

Ask an LLM

“How do I add a new custom field to an envelope that's already out?”

“Do custom fields I add to an envelope need unique names?”

Tell an agent

Add text custom fields {textCustomFields} to envelope {envelope} in account {account}.

Add new list custom fields {listCustomFields} to envelope {envelope}.

DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Delete custom fields from an envelope · Docusign Deletes envelope custom fields for draft and in-process envelopes #

Ask an LLM

“How do I remove custom fields from a draft envelope?”

“Can I delete a single custom field from an in-process envelope?”

Tell an agent destructive · confirm first

Delete text custom fields {textCustomFields} from envelope {envelope} in account {account}.

Remove list custom fields {listCustomFields} from envelope {envelope}.

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Gets the custom field information for the specified envelope #

PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Updates envelope custom fields in an envelope #

POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Creates envelope custom fields for an envelope #

DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields Deletes envelope custom fields for draft and in-process envelopes #

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-envelopecustomfields-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 Custom Fields API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeCustomFields 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: EnvelopeCustomFields
  description: 'The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope.


    Custom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.


    There are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.'
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields:
    get:
      tags:
      - EnvelopeCustomFields
      summary: Docusign Gets the custom field information for the specified envelope
      description: 'Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.


        There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.'
      operationId: CustomFields_GetCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        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/customFieldsEnvelope'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listCustomFields
      x-ds-method: list
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeCustomFields
      summary: Docusign Updates envelope custom fields in an envelope
      description: 'Updates the envelope custom fields in draft and in-process envelopes.


        Each custom field used in an envelope must have a unique name.'
      operationId: CustomFields_PutCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        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/EnvelopeCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateCustomFields
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeCustomFields
    post:
      tags:
      - EnvelopeCustomFields
      summary: Docusign Updates envelope custom fields for an envelope
      description: 'Updates the envelope custom fields for draft and in-process envelopes.


        Each custom field used in an envelope must have a unique name.'
      operationId: CustomFields_PostCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        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/EnvelopeCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createCustomFields
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeCustomFields
    delete:
      tags:
      - EnvelopeCustomFields
      summary: Docusign Deletes envelope custom fields for draft and in-process envelopes
      description: Deletes envelope custom fields for draft and in-process envelopes.
      operationId: CustomFields_DeleteCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        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/EnvelopeCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnvelopeCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteCustomFields
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: EnvelopeCustomFields
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields:
    parameters: []
    get:
      tags:
      - EnvelopeCustomFields
      summary: Gets the custom field information for the specified envelope
      description: 'Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients.


        There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.


        ### Related topics


        - How to get envelope custom tab values'
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        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/customFieldsEnvelope'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listCustomFields
      x-ds-method: list
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_GetCustomFields
    put:
      tags:
      - EnvelopeCustomFields
      summary: Updates envelope custom fields in an envelope
      description: 'Updates the envelope custom fields in draft and in-process envelopes.


        Each custom field used in an envelope must have a unique name.'
      operationId: putV21AccountsByAccountIdEnvelopesByEnvelopeIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        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/EnvelopeCustomFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateCustomFields
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_PutCustomFields
    post:
      tags:
      - EnvelopeCustomFields
      summary: Creates envelope custom fields for an envelope
      description: 'Updates the envelope custom fields for draft and in-process envelopes.


        ### Related topics


        - How to bulk send envelopes'
      operationId: postV21AccountsByAccountIdEnvelopesByEnvelopeIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        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/EnvelopeCustomFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: createCustomFields
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_PostCustomFields
    delete:
      tags:
      - EnvelopeCustomFields
      summary: Deletes envelope custom fields for draft and in-process envelopes
      description: Deletes envelope custom fields for draft and in-process envelopes.
      operationId: deleteV21AccountsByAccountIdEnvelopesByEnvelopeIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        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/EnvelopeCustomFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteCustomFields
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/EnvelopeCustomFields_2'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_DeleteCustomFields
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    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.
    customFieldsEnvelope:
      type: object
      properties:
        listCustomFields:
          type: array
          description: An array of list custom fields.
          items:
            $ref: '#/components/schemas/listCustomField'
        textCustomFields:
          type: array
          description: An array of text custom fields.
          items:
            $ref: '#/components/schemas/textCustomField'
      description: ''
      x-ds-definition-name: customFieldsEnvelope
      x-ms-summary: ''
    listCustomField:
      type: object
      properties:
        configurationType:
          type: string
          description: If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        fieldId:
          type: string
          description: An ID used to specify a custom field.
        listItems:
          type: array
          description: ''
          items:
            type: string
        name:
          type: string
          description: The name of the custom field.
        required:
          type: string
          description: When set to **true**, the signer is required to fill out this tab
        show:
          type: string
          description: 'A boolean indicating if the value should be displayed.  If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. '
        value:
          type: string
          description: 'The value of the custom field.


            Maximum Length: 100 characters.'
      description: ''
      x-ds-definition-name: listCustomField
      x-ms-summary: ''
    textCustomField:
      type: object
      properties:
        configurationType:
          type: string
          description: If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        fieldId:
          type: string
          description: An ID used to specify a custom field.
        name:
          type: string
          description: The name of the custom field.
        required:
          type: string
          description: When set to **true**, the signer is required to fill out this tab
        show:
          type: string
          description: 'A boolean indicating if the value should be displayed.  If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. '
        value:
          type: string
          description: The value of the custom field.
      description: ''
      x-ds-definition-name: textCustomField
      x-ms-summary: ''
    EnvelopeCustomFields:
      type: object
      properties:
        listCustomFields:
          type: array
          description: An array of list custom fields.
          items:
            $ref: '#/components/schemas/listCustomField'
        textCustomFields:
          type: array
          description: An array of text custom fields.
          items:
            $ref: '#/components/schemas/textCustomField'
      description: Envelope custom fields
      x-ds-definition-name: customFields
      x-ds-category: Envelopes
      x-ds-order: '70'
      x-ms-summary: Envelope custom fields
    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.
    listCustomField_2:
      type: object
      properties:
        configurationType:
          description: If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        fieldId:
          description: The ID of the custom field.
          type: string
        listItems:
          description: 'An array of strings that represents the options in a list.


            Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters.'
          type: array
          items:
            type: string
        name:
          description: The name of the custom field.
          type: string
        required:
          description: When **true,** senders are required to select an option from the list before they can send the envelope.
          type: string
        show:
          description: When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.
          type: string
        value:
          description: The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list.
          type: string
      description: This object represents a list custom field from which envelope creators and senders can select custom data.
      x-ds-definition-name: listCustomField
      x-ms-summary: This object represents a list custom field from which envelope creators and senders can select custom data.
    textCustomField_2:
      type: object
      properties:
        configurationType:
          description: If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        fieldId:
          description: The ID of the custom field.
          type: string
        name:
          description: The name of the custom field.
          type: string
        required:
          description: When **true,** senders are required to enter or select information for the field before they can send the envelope.
          type: string
        show:
          description: When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.
          type: string
        value:
          description: 'The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters.'
          type: string
      description: This object represents a free text custom field where envelope creators and senders can enter custom data.
      x-ds-definition-name: textCustomField
      x-ms-summary: This object represents a free text custom field where envelope creators and senders can enter custom data.
    EnvelopeCustomFields_2:
      description: 'An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No".


        When a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the Docusign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).'
      type: object
      properties:
        listCustomFields:
          description: An array of list custom fields.
          type: array
          items:
            $ref: '#/components/schemas/listCustomField_2'
        textCustomFields:
          description: An array of text custom fields.
          type: array
          items:
            $ref: '#/components/schemas/textCustomField_2'
      x-ds-definition-name: customFields
      x-ds-category: Envelopes
      x-ds-order: '70'
      x-ms-summary: 'An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No".


        When a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the Docusign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).'
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 EnvelopeCustomFields 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