Skip to content

DocuSign: Updates recipients in a template

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

← Esignature operations · Get started

Operation docusign.esignature_recipients_puttemplaterecipients

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients. 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"]["esignatureRecipientsPutTemplateRecipients"]>[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.esignatureRecipientsPutTemplateRecipients(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_recipients_put_template_recipients(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
path.templateIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.resend_envelopestringOptional
bodyModelOptionalExpand Updates recipients in a template — request body — body

Referenced models: Updates recipients in a template — 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 Updates recipients in a template — response body

Referenced models: Updates recipients in a template — response body

108 more schemas are linked from the tables above, on the schema pages.

Updates recipients in a template — response body
FieldTypePresenceDescription and constraints
$objectRootThis is the response that the API returns after you update recipients.
recipientUpdateResultsarrayOptionalAn array of `recipientUpdateResults` objects that contain details about the recipients.
recipientUpdateResults[]ModelEach itemExpand Updates an existing template — response body — recipient Update Results item

Referenced models: Updates an existing template — response body — recipient Update Results item

Updates recipients in a template — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Updates recipients in a template — request body — body authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Updates recipients in a template — request body — body carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Updates recipients in a template — request body — body in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Updates recipients in a template — request body — body notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Updates recipients in a template — request body — body notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:

* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
* includeDocuments - When **true,** the envelope time zone information is included in the message.
sealsarrayOptionalSpecifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html
seals[]ModelEach itemExpand Updates recipients in a template — request body — body seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Updates recipients in a template — request body — body signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Updates recipients in a template — request body — body witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — participants item, Updates recipients in a template — request body — body authorized Signatories item, Updates recipients in a template — request body — body carbon Copies item, Updates recipients in a template — request body — body in Person Signers item, Updates recipients in a template — request body — body notaries item, Updates recipients in a template — request body — body notary Witnesses item, Updates recipients in a template — request body — body seals item, Updates recipients in a template — request body — body signers item, Updates recipients in a template — request body — body witnesses item

Updates an existing template — response body — recipient Update Results item
FieldTypePresenceDescription and constraints
$objectRootThe recipient details that are returned after you update the recipient.
combinedstringOptionalWhen you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body
All of the tabs associated with the recipient.

Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, 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.
Deletes recipients from a template — response body — agents item consent Details List item
FieldTypePresenceDescription and constraints
$objectRoot
consentKeystringOptional
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
signerConsentStatusstringOptional
Deletes recipients from a template — response body — seals item recipient Feature Metadata item
FieldTypePresenceDescription and constraints
$objectRoot
availabiltystringOptional
featureNamestringOptional

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