DocuSign: Adds one or more recipients to an envelope
DocuSign esignature.esignatureRecipientsPostRecipients: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_recipients_postrecipients
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients. 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"]["esignatureRecipientsPostRecipients"]>[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.esignatureRecipientsPostRecipients(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_recipients_post_recipients(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.envelopeId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.resend_envelope | string | Optional | |
body | Model | Optional | Expand Deletes recipients from an envelope — request body — body |
Referenced models: Deletes recipients from an envelope — 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 Deletes recipients from an envelope — response body |
Referenced models: Deletes recipients from an envelope — response body
Schemas
Section titled “Schemas”115 more schemas are linked from the tables above, on the schema pages.
Deletes recipients from an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope recipients |
agents | array | Optional | A list of agent recipients assigned to the documents. |
agents[] | Model | Each item | Expand Deletes recipients from a template — response body — agents item |
authorizedSignatories | array | Optional | |
authorizedSignatories[] | Model | Each item | Expand Deletes recipients from a template — response body — authorized Signatories item |
carbonCopies | array | Optional | A list of carbon copy recipients assigned to the documents. |
carbonCopies[] | Model | Each item | Expand Deletes recipients from a template — response body — carbon Copies item |
certifiedDeliveries | array | Optional | A 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[] | Model | Each item | Expand Deletes recipients from a template — response body — certified Deliveries item |
currentRoutingOrder | string | Optional | The 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. |
editors | array | Optional | A list of users who can edit the envelope. |
editors[] | Model | Each item | Expand Deletes recipients from a template — response body — editors item |
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. |
inPersonSigners | array | Optional | Specifies 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[] | Model | Each item | Expand Deletes recipients from a template — response body — in Person Signers item |
intermediaries | array | Optional | Identifies 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[] | Model | Each item | Expand Deletes recipients from a template — response body — intermediaries item |
notaries | array | Optional | A list of notary recipients on the envelope. |
notaries[] | Model | Each item | Expand Deletes recipients from a template — response body — notaries item |
notaryWitnesses | array | Optional | |
notaryWitnesses[] | Model | Each item | Expand Deletes recipients from a template — response body — notary Witnesses item |
participants | array | Optional | |
participants[] | Model | Each item | Expand Deletes recipients from a template — response body — participants item |
recipientCount | string | Optional | The number of recipients in the envelope. |
seals | array | Optional | A list of electronic seals to apply to documents. |
seals[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item |
signers | array | Optional | A list of signers on the envelope. |
signers[] | Model | Each item | Expand Deletes recipients from a template — response body — signers item |
witnesses | array | Optional | A list of signers who act as witnesses on the envelope. |
witnesses[] | Model | Each item | Expand Deletes recipients from a template — response body — witnesses item |
Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — authorized Signatories item, Deletes recipients from a template — response body — carbon Copies 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 — in Person Signers item, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — notaries item, Deletes recipients from a template — response body — notary Witnesses item, Deletes recipients from a template — response body — participants item, Deletes recipients from a template — response body — seals item, Deletes recipients from a template — response body — signers item, Deletes recipients from a template — response body — witnesses 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. |
Deletes recipients from a template — response body — agents item consent Details List item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
consentKey | string | Optional | |
deliveryMethod | string | Optional | The 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/ |
signerConsentStatus | string | Optional |
Updates document visibility for recipients — response body — document Visibility item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object configures a recipient's read/write access to a document. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
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. |
recipientId | string | Optional | The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object. |
rights | string | Optional | Indicates whether the document is editable: - `editable` - `read_only` |
visible | string | Optional | When **true,** the document is visible to the recipient. |
Referenced models: Locks a template — response body — error Details
Deletes recipients from a template — response body — seals item recipient Feature Metadata item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
availabilty | string | Optional | |
featureName | string | Optional |
Updates a template document — response body — name Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about a property. |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
Deletes recipients from a template — response body — seals item recipient Attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` |
data | string | Optional | A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. |
label | string | Optional | An optional label for the attachment. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_recipients_postrecipients. Catalog operation: esignature:Recipients_PostRecipients. 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.