Docusign

Docusign TemplateDocumentFields API

The TemplateDocumentFields 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}/templates/{templateId}/documents/{documentId}/fields Get custom fields on a template document · Docusign Gets the custom document fields for a an existing template document #

Ask an LLM

“What custom document fields are defined on a template's document?”

“Can I read the metadata fields of a template document?”

Tell an agent

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

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

PUT /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Update custom fields on a template document · Docusign Updates existing custom document fields in an existing template… #

Ask an LLM

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

“Can I edit document fields stored in a template?”

Tell an agent

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

Change the existing document field values of template {template} document {document} in account {account}.

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

Ask an LLM

“Can I add new custom metadata fields to a template document?”

“How do I create document fields inside a template?”

Tell an agent

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

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

DELETE /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Remove custom fields from a template document · Docusign Deletes custom document fields from an existing template document #

Ask an LLM

“Can I delete custom fields from a template document?”

“How do I clear metadata fields off a document in a template?”

Tell an agent destructive · confirm first

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

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

GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Gets the custom document fields for a an existing template document #

PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Updates existing custom document fields in an existing template document #

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

DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Deletes custom document fields from an existing template 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-templatedocumentfields-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 Document Fields API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged TemplateDocumentFields 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: TemplateDocumentFields
  description: 'The TemplateDocumentFields 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}/templates/{templateId}/documents/{documentId}/fields:
    get:
      tags:
      - TemplateDocumentFields
      summary: Docusign Gets the custom document fields for a an existing template document
      description: Retrieves the custom document fields for an existing template document.
      operationId: DocumentFields_GetTemplateDocumentFields
      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: 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/documentFieldsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listDocumentFields
      x-ds-method: list
      x-ds-service: Templates
      x-ds-in-sdk: true
    put:
      tags:
      - TemplateDocumentFields
      summary: Docusign Updates existing custom document fields in an existing template…
      description: Updates existing custom document fields in an existing template document.
      operationId: DocumentFields_PutTemplateDocumentFields
      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: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentFieldsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateDocumentFields
      x-ds-method: update
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: documentFieldsInformation
    post:
      tags:
      - TemplateDocumentFields
      summary: Docusign Creates custom document fields in an existing template document
      description: Creates custom document fields in an existing template document.
      operationId: DocumentFields_PostTemplateDocumentFields
      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: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentFieldsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createDocumentFields
      x-ds-method: create
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: documentFieldsInformation
    delete:
      tags:
      - TemplateDocumentFields
      summary: Docusign Deletes custom document fields from an existing template document
      description: Deletes custom document fields from an existing template document.
      operationId: DocumentFields_DeleteTemplateDocumentFields
      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: templateId
        in: path
        description: The ID of the template being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentFieldsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteDocumentFields
      x-ds-method: delete
      x-ds-service: Templates
      x-ds-in-sdk: true
      x-codegen-request-body-name: documentFieldsInformation
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields:
    parameters: []
    get:
      tags:
      - TemplateDocumentFields
      summary: Gets the custom document fields for a an existing template document
      description: This method retrieves the custom document fields for an existing template document.
      operationId: getV21AccountsByAccountIdTemplatesByTemplateIdDocumentsByDocumentIdFields
      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: 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/documentFieldsInformation_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: Templates
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_GetTemplateDocumentFields
    put:
      tags:
      - TemplateDocumentFields
      summary: Updates existing custom document fields in an existing template document
      description: Updates existing custom document fields in an existing template document.
      operationId: putV21AccountsByAccountIdTemplatesByTemplateIdDocumentsByDocumentIdFields
      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: 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/documentFieldsInformation_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_PutTemplateDocumentFields
    post:
      tags:
      - TemplateDocumentFields
      summary: Creates custom document fields in an existing template document
      description: Creates custom document fields in an existing template document.
      operationId: postV21AccountsByAccountIdTemplatesByTemplateIdDocumentsByDocumentIdFields
      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: 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/documentFieldsInformation_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_PostTemplateDocumentFields
    delete:
      tags:
      - TemplateDocumentFields
      summary: Deletes custom document fields from an existing template document
      description: Deletes custom document fields from an existing template document.
      operationId: deleteV21AccountsByAccountIdTemplatesByTemplateIdDocumentsByDocumentIdFields
      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: 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/documentFieldsInformation_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: Templates
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentFieldsInformation_2'
      x-operation-id-source: normalized
      x-operation-id-original: DocumentFields_DeleteTemplateDocumentFields
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    documentFieldsInformation:
      type: object
      properties:
        documentFields:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
      description: ''
      x-ds-definition-name: documentFieldsInformation
      x-ms-summary: ''
    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.
    documentFieldsInformation_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\nIf 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: ''
      x-ms-summary: ''
    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.
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 TemplateDocumentFields 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