Skip to content

DocuSign: Set one or more templates as account favorites

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

← Esignature operations · Get started

Operation docusign.esignature_favoritetemplates_putfavoritetemplate

Provider route: PUT /restapi/v2.1/accounts/{accountId}/favorite_templates. 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"]["esignatureFavoriteTemplatesPutFavoriteTemplate"]>[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.esignatureFavoriteTemplatesPutFavoriteTemplate(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_favorite_templates_put_favorite_template(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 Set one or more templates as account favorites — request body — body

Referenced models: Set one or more templates as account favorites — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Set one or more templates as account favorites — response body

Referenced models: Set one or more templates as account favorites — response body

Set one or more templates as account favorites — response body
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoriteTemplatesarrayOptionalThe favorite templates acted upon by the call.
favoriteTemplates[]ModelEach itemExpand Set one or more templates as account favorites — response body — favorite Templates item
templatesUpdatedCountJSONOptional
templatesUpdatedCount (anyOf 1)integerAlternativeThe number of templates successfully updated by the call. This property is read-only.
Format: int32
templatesUpdatedCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Locks a template — response body — error Details, Set one or more templates as account favorites — response body — favorite Templates item

Set one or more templates as account favorites — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoriteTemplatesarrayOptionalThe favorite templates acted upon by the call.
favoriteTemplates[]ModelEach itemExpand Set one or more templates as account favorites — response body — favorite Templates item
templatesUpdatedCountintegerOptionalThe number of templates successfully updated by the call. This property is read-only.
Format: int32

Referenced models: Locks a template — response body — error Details, Set one or more templates as account favorites — response body — favorite Templates item

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.
Set one or more templates as account favorites — response body — favorite Templates item
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoritedDatestringOptionalTime at which the template was marked as favorite.
templateIdstringOptionalThe ID of the template.

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

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