DocuSign: Updates the notification structure for an existing template
DocuSign esignature.esignatureNotificationPutTemplatesTemplateIdNotification: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_notification_puttemplatestemplateidnotification
Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}/notification. 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"]["esignatureNotificationPutTemplatesTemplateIdNotification"]>[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.esignatureNotificationPutTemplatesTemplateIdNotification(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_notification_put_templates_template_id_notification(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 | |
body | Model | Optional | Expand Updates the notification structure for an existing template — request body — body |
Referenced models: Updates the notification structure for an existing template — 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 Gets envelope notification information — response body |
Referenced models: Gets envelope notification information — response body
Schemas
Section titled “Schemas”Gets envelope notification information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the notification settings for the envelope. |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
useAccountDefaults | string | Optional | When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Updates the notification structure for an existing template — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
useAccountDefaults | string | Optional | When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Gets envelope notification information — response body — expirations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided. |
expireAfter | string | Optional | An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.** |
expireEnabled | string | Optional | When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html). |
expireWarn | string | Optional | An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent. |
Gets envelope notification information — response body — reminders
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies reminder settings for the envelope. |
maximumReminderCount | string | Optional | |
reminderDelay | string | Optional | An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0. |
reminderEnabled | string | Optional | When **true,** reminders are enabled. The default value is **false.** |
reminderFrequency | string | Optional | An integer specifying the interval in days between reminder emails. The default value is 0. |
smartReminderEnabled | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_notification_puttemplatestemplateidnotification. Catalog operation: esignature:Notification_PutTemplatesTemplateIdNotification. 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.