DocuSign: Remove one or more templates from the account favorites
DocuSign esignature.esignatureFavoriteTemplatesUnFavoriteTemplate: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_favoritetemplates_unfavoritetemplate
Provider route: DELETE /restapi/v2.1/accounts/{accountId}/favorite_templates. 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"]["esignatureFavoriteTemplatesUnFavoriteTemplate"]>[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.esignatureFavoriteTemplatesUnFavoriteTemplate(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_favorite_templates_un_favorite_template(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 | |
body | Model | Optional | Expand 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
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 Set one or more templates as account favorites — response body |
Referenced models: Set one or more templates as account favorites — response body
Schemas
Section titled “Schemas”Set one or more templates as account favorites — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
favoriteTemplates | array | Optional | The favorite templates acted upon by the call. |
favoriteTemplates[] | Model | Each item | Expand Set one or more templates as account favorites — response body — favorite Templates item |
templatesUpdatedCount | JSON | Optional | |
templatesUpdatedCount (anyOf 1) | integer | Alternative | The number of templates successfully updated by the call. This property is read-only. Format: int32 |
templatesUpdatedCount (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
favoriteTemplates | array | Optional | The favorite templates acted upon by the call. |
favoriteTemplates[] | Model | Each item | Expand Set one or more templates as account favorites — response body — favorite Templates item |
templatesUpdatedCount | integer | Optional | The 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
| 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. |
Set one or more templates as account favorites — response body — favorite Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
favoritedDate | string | Optional | Time at which the template was marked as favorite. |
templateId | string | Optional | The ID of the template. |
Referenced models: Locks a template — response body — error Details
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_favoritetemplates_unfavoritetemplate. Catalog operation: esignature:FavoriteTemplates_UnFavoriteTemplate. 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.