Skip to content

DocuSign: esignature:Templates Auto Match Put Templates

DocuSign esignature.esignatureTemplatesAutoMatchPutTemplates: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_templatesautomatch_puttemplates

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/auto_match. Alter supplies the connection’s credentials and routing.

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"]["esignatureTemplatesAutoMatchPutTemplates"]>[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.esignatureTemplatesAutoMatchPutTemplates(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_templates_auto_match_put_templates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
bodyModelOptionalExpand esignature:Templates Put Templates — response body

Referenced models: esignature:Templates Put Templates — response body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand esignature:Templates Put Templates — response body

Referenced models: esignature:Templates Put Templates — response body

esignature:Templates Put Templates — response body
FieldTypePresenceDescription and constraints
$objectRoot
templatesarrayOptionalAn array of `templateSummary` objects that contain information about templates.
templates[]ModelEach itemExpand esignature:Templates Put Templates — response body — templates item

Referenced models: esignature:Templates Put Templates — response body — templates item

esignature:Templates Put Templates — response body — templates item
FieldTypePresenceDescription and constraints
$objectRoot
autoMatchstringOptionalBy default, templates that have been used within
the last 60 days are included in auto-matching.

By explicitly setting `autoMatch`,
you can permanently include or exclude the template
in auto matching.

When **true** the template is included in auto-matching
regardless of when it was last used.

When **false** the template is never included in auto-matching.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
templateIdstringOptionalThe ID of the template.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_templatesautomatch_puttemplates. Catalog operation: esignature:TemplatesAutoMatch_PutTemplates. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.