DocuSign: Gets the custom document fields from a template
DocuSign esignature.esignatureCustomFieldsGetTemplateCustomFields: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_customfields_gettemplatecustomfields
Provider route: GET /restapi/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureCustomFieldsGetTemplateCustomFields"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureCustomFieldsGetTemplateCustomFields(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_custom_fields_get_template_custom_fields(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.templateId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Deletes envelope custom fields in a template — response body |
Referenced models: Deletes envelope custom fields in a template — response body
Schemas
Section titled “Schemas”Deletes envelope custom fields in a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about custom fields. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item
Gets a list of custom fields — response body — list Custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a list custom field from which envelope creators and senders can select custom data. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | Optional | The ID of the custom field. |
listItems | array | Optional | 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. |
listItems[] | string | Each item | |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** senders are required to select an option from the list before they can send the envelope. |
show | string | Optional | When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. |
value | string | Optional | The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. |
Referenced models: Locks a template — response body — error Details
Gets a list of custom fields — response body — text Custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a free text custom field where envelope creators and senders can enter custom data. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | Optional | The ID of the custom field. |
name | string | Optional | The name of the custom field. |
required | string | Optional | When **true,** senders are required to enter or select information for the field before they can send the envelope. |
show | string | Optional | When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. |
value | string | Optional | The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters. |
Referenced models: Locks a template — response body — error Details
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_customfields_gettemplatecustomfields. Catalog operation: esignature:CustomFields_GetTemplateCustomFields. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.