Docusign

Docusign AccountCustomFields API

The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account. These fields can be used with your account's envelopes to record information about the envelopes. The fields can be searched to find matching envelopes and track information. The envelope custom fields are shown in the DocuSign member console's Envelope Settings section when a user creates an envelope. The envelope custom fields are not seen by 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. The list custom field lets the sender select the value of the field from a pre-determined 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}/custom_fields List account-level envelope custom fields · Docusign Gets a list of custom fields associated with the account #

Ask an LLM

“What envelope custom fields are defined for my account?”

“Which custom fields can senders use to tag envelopes for search and reporting?”

Tell an agent

List the account custom fields for account {account}.

Show envelope custom field definitions in account {account}.

POST /v2/accounts/{accountId}/custom_fields Create an account custom field · Docusign Creates an acount custom field #

Ask an LLM

“How do I add a new custom field that all envelopes in my account can use?”

“Can I create a list-type custom field with fixed choices?”

Tell an agent

Create an account custom field named {name} in account {account}.

Create list custom field {name} with items {listItems}, required: {required}.

PUT /v2/accounts/{accountId}/custom_fields/{customFieldId} Update an account custom field · Docusign Updates an existing account custom field #

Ask an LLM

“How do I change the options on an existing account custom field?”

“Can I apply a custom field change to my templates too?”

Tell an agent

Update account custom field {field} in account {account} to name {name}.

Change list items of account custom field {field} to {listItems}, applying to templates: {apply_to_templates}.

DELETE /v2/accounts/{accountId}/custom_fields/{customFieldId} Delete an account custom field · Docusign Delete an existing account custom field #

Ask an LLM

“How do I remove an account-wide custom field?”

“Can I delete a custom field from templates at the same time?”

Tell an agent destructive · confirm first

Delete account custom field {field} from account {account}.

Delete account custom field {field} and remove it from templates: {apply_to_templates}.

GET /v2.1/accounts/{accountId}/custom_fields Gets a list of custom fields #

POST /v2.1/accounts/{accountId}/custom_fields Creates an account custom field #

PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId} Updates an account custom field #

DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId} Deletes an account custom field #

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-accountcustomfields-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 Account Custom Fields API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged AccountCustomFields 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: AccountCustomFields
  description: 'The CustomFields resource provides a method that enables you to retrieve the custom fields associated with an account.


    These fields can be used with your account''s envelopes to record information about the envelopes. The fields can be searched to find matching envelopes and track information.


    The envelope custom fields are shown in the DocuSign member console''s Envelope Settings section when a user creates an envelope. The envelope custom fields are not seen by 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. The list custom field lets the sender select the value of the field from a pre-determined list.'
paths:
  /v2/accounts/{accountId}/custom_fields:
    get:
      tags:
      - AccountCustomFields
      summary: Docusign Gets a list of custom fields associated with the account
      description: 'Retrieves a list of envelope custom fields associated with the account. 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. The list custom field lets the sender select the value of the field from a list you provide.'
      operationId: AccountCustomFields_GetAccountCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccountCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listCustomFields
      x-ds-method: list
      x-ds-service: Accounts
      x-ds-in-sdk: true
    post:
      tags:
      - AccountCustomFields
      summary: Docusign Creates an acount custom field
      operationId: AccountCustomFields_PostAccountCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: apply_to_templates
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customField'
          application/xml:
            schema:
              $ref: '#/components/schemas/customField'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccountCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createCustomField
      x-ds-method: create
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-codegen-request-body-name: customField
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/custom_fields/{customFieldId}:
    put:
      tags:
      - AccountCustomFields
      summary: Docusign Updates an existing account custom field
      operationId: AccountCustomFields_PutAccountCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: customFieldId
        in: path
        required: true
        schema:
          type: string
      - name: apply_to_templates
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customField'
          application/xml:
            schema:
              $ref: '#/components/schemas/customField'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AccountCustomFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateCustomField
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-codegen-request-body-name: customField
    delete:
      tags:
      - AccountCustomFields
      summary: Docusign Delete an existing account custom field
      operationId: AccountCustomFields_DeleteAccountCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: customFieldId
        in: path
        required: true
        schema:
          type: string
      - name: apply_to_templates
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content: {}
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteCustomField
      x-ds-method: delete
      x-ds-service: Accounts
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/custom_fields:
    parameters: []
    get:
      tags:
      - AccountCustomFields
      summary: Gets a list of custom fields
      description: This method returns a list of the envelope and document custom fields associated with an account.
      operationId: getV21AccountsByAccountIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCustomFields_2'
        '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: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: AccountCustomFields_GetAccountCustomFields
    post:
      tags:
      - AccountCustomFields
      summary: Creates an account custom field
      operationId: postV21AccountsByAccountIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: apply_to_templates
        in: query
        required: false
        description: (Optional) When **true,** the new custom field is applied to all of the templates on the account.
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCustomFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: createCustomField
      description: This method creates a custom field and makes it available for all new envelopes associated with an account.
      x-ds-method: create
      x-ds-service: Accounts
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customField_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/customField_2'
      x-operation-id-source: normalized
      x-operation-id-original: AccountCustomFields_PostAccountCustomFields
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/custom_fields/{customFieldId}:
    parameters: []
    put:
      tags:
      - AccountCustomFields
      summary: Updates an account custom field
      operationId: putV21AccountsByAccountIdCustomFieldsByCustomFieldId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: customFieldId
        in: path
        required: true
        description: The ID of the custom field.
        schema:
          type: string
      - name: apply_to_templates
        in: query
        required: false
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCustomFields_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateCustomField
      description: This method updates an existing account custom field.
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customField_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/customField_2'
      x-operation-id-source: normalized
      x-operation-id-original: AccountCustomFields_PutAccountCustomFields
    delete:
      tags:
      - AccountCustomFields
      summary: Deletes an account custom field
      operationId: deleteV21AccountsByAccountIdCustomFieldsByCustomFieldId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: customFieldId
        in: path
        required: true
        description: The ID of the custom field.
        schema:
          type: string
      - name: apply_to_templates
        in: query
        required: false
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteCustomField
      description: This method deletes an existing account custom field.
      x-ds-method: delete
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: AccountCustomFields_DeleteAccountCustomFields
    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.
    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: ''
    AccountCustomFields:
      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: Custom Fields
      x-ds-definition-name: customFields
      x-ds-category: Accounts
      x-ds-order: '30'
      x-ms-summary: Custom Fields
    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: ''
    customField:
      type: object
      properties:
        customFieldType:
          type: string
          description: ''
        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: ''
        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: 'Specifies the value of the tab. '
      description: ''
      x-ds-definition-name: customField
      x-ms-summary: ''
    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.
    AccountCustomFields_2:
      description: 'An `accountCustomField` is an envelope custom field that you set at the account level.

        Applying custom fields enables account administrators to group and manage envelopes.

        '
      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: Accounts
      x-ds-order: '30'
      x-ms-summary: 'An `accountCustomField` is an envelope custom field that you set at the account level.

        Applying custom fields enables account administrators to group and manage envelopes.

        '
    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.
    customField_2:
      type: object
      properties:
        customFieldType:
          description: 'The type of custom field. Valid values are:


            - `text` (default)

            - `list`'
          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: "For a list custom field, this is an array of strings that represent the items in a list. \n\nMaximum Length: 2,000 characters."
          type: array
          items:
            type: string
        name:
          description: The name of the custom field.
          type: string
        required:
          description: When **true,** the signer must complete the custom field.
          type: string
        show:
          description: When **true,** the custom field displays at the top of the Certificate of Completion.
          type: string
        value:
          description: "Specifies the value of the custom field. \n\nMaximum Length: 2,000 characters."
          type: string
      description: This object provides details about a custom field.
      x-ds-definition-name: customField
      x-ms-summary: This object provides details about a custom field.
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 AccountCustomFields 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