Docusign

Docusign TemplateCustomFields API

The TemplateCustomFields resource provides methods that allow you manage custom fields in an template. Custom fields can be used in the templates for your account to record information about the template, help search for templates and track information. The template custom fields are shown in the Template Settings section when a user is creating an template in the DocuSign member console. The template custom fields are not seen by the template recipients. There are two types of template 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}/templates/{templateId}/custom_fields Get custom fields on a template · Docusign Gets the custom document fields from a template #

Ask an LLM

“What custom fields are defined on a template?”

“Can I see a template's list and text custom fields?”

Tell an agent

Get the custom fields of template {template} in account {account}.

Show custom field definitions on template {template}.

PUT /v2/accounts/{accountId}/templates/{templateId}/custom_fields Update custom fields on a template · Docusign Updates envelope custom fields in a template #

Ask an LLM

“How do I change an existing custom field on a template?”

“Can I update a template's list custom field choices?”

Tell an agent

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

Change list custom fields on template {template} to {listCustomFields}.

POST /v2/accounts/{accountId}/templates/{templateId}/custom_fields Add custom fields to a template · Docusign Creates custom document fields in an existing template document #

Ask an LLM

“How do I add new custom fields to a template?”

“Can every envelope built from a template carry a custom field I add to it?”

Tell an agent

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

Create list custom fields {listCustomFields} on template {template}.

DELETE /v2/accounts/{accountId}/templates/{templateId}/custom_fields Delete custom fields from a template · Docusign Deletes envelope custom fields in a template #

Ask an LLM

“How do I remove custom fields from a template?”

“Can I delete only the list custom fields on a template?”

Tell an agent destructive · confirm first

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

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

GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields Gets the custom document fields from a template #

PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields Updates envelope custom fields in a template #

POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields Creates custom document fields in an existing template document #

DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields Deletes envelope custom fields in a template #

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


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


    There are two types of template 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}/templates/{templateId}/custom_fields:
    get:
      tags:
      - TemplateCustomFields
      summary: Docusign Gets the custom document fields from a template
      description: Retrieves the custom document field information from an existing template.
      operationId: CustomFields_GetTemplateCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listCustomFields
      x-ds-method: list
      x-ds-service: Templates
      x-ds-in-sdk: true
    put:
      tags:
      - TemplateCustomFields
      summary: Docusign Updates envelope custom fields in a template
      description: 'Updates the custom fields in a template.


        Each custom field used in a template must have a unique name.'
      operationId: CustomFields_PutTemplateCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateCustomFields
      x-ds-method: update
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: templateCustomFields
    post:
      tags:
      - TemplateCustomFields
      summary: Docusign Creates custom document fields in an existing template document
      description: Creates custom document fields in an existing template document.
      operationId: CustomFields_PostTemplateCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createCustomFields
      x-ds-method: create
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: templateCustomFields
    delete:
      tags:
      - TemplateCustomFields
      summary: Docusign Deletes envelope custom fields in a template
      description: Deletes envelope custom fields in a template.
      operationId: CustomFields_DeleteTemplateCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customFields'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteCustomFields
      x-ds-method: delete
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: templateCustomFields
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields:
    parameters: []
    get:
      tags:
      - TemplateCustomFields
      summary: Gets the custom document fields from a template
      description: Retrieves the custom document field information from an existing template.
      operationId: getV21AccountsByAccountIdTemplatesByTemplateIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customFields_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: Templates
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_GetTemplateCustomFields
    put:
      tags:
      - TemplateCustomFields
      summary: Updates envelope custom fields in a template
      description: 'Updates the custom fields in a template.


        Each custom field used in a template must have a unique name.'
      operationId: putV21AccountsByAccountIdTemplatesByTemplateIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customFields_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_PutTemplateCustomFields
    post:
      tags:
      - TemplateCustomFields
      summary: Creates custom document fields in an existing template document
      description: Creates custom document fields in an existing template document.
      operationId: postV21AccountsByAccountIdTemplatesByTemplateIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customFields_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_PostTemplateCustomFields
    delete:
      tags:
      - TemplateCustomFields
      summary: Deletes envelope custom fields in a template
      description: Deletes envelope custom fields in a template.
      operationId: deleteV21AccountsByAccountIdTemplatesByTemplateIdCustomFields
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: The ID of the template.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customFields_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
          application/xml:
            schema:
              $ref: '#/components/schemas/templateCustomFields'
      x-operation-id-source: normalized
      x-operation-id-original: CustomFields_DeleteTemplateCustomFields
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    templateCustomFields:
      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: templateCustomFields
      x-ms-summary: ''
    customFields:
      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: customFields
      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.
    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: ''
    customFields_2:
      description: Contains information about custom fields.
      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-ms-summary: Contains information about 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.
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 TemplateCustomFields 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