DocuSign: Deletes the signature for one or more captive recipient records
DocuSign esignature.esignatureCaptiveRecipientsDeleteCaptiveRecipientsPart: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_captiverecipients_deletecaptiverecipientspart
Provider route: DELETE /restapi/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}. 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"]["esignatureCaptiveRecipientsDeleteCaptiveRecipientsPart"]>[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.esignatureCaptiveRecipientsDeleteCaptiveRecipientsPart(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_captive_recipients_delete_captive_recipients_part(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.recipientPart | string | Required within parent | |
body | Model | Optional | Expand Deletes the signature for one or more captive recipient records — response body |
Referenced models: Deletes the signature for one or more captive recipient records — response 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 the signature for one or more captive recipient records — response body |
Referenced models: Deletes the signature for one or more captive recipient records — response body
Schemas
Section titled “Schemas”Deletes the signature for one or more captive recipient records — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about captive (embedded) recipients. |
captiveRecipients | array | Optional | A complex type containing information about one or more captive recipients. |
captiveRecipients[] | Model | Each item | Expand Deletes the signature for one or more captive recipient records — response body — captive Recipients item |
Referenced models: Deletes the signature for one or more captive recipient records — response body — captive Recipients item
Deletes the signature for one or more captive recipient records — response body — captive Recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a captive (embedded) recipient. |
clientUserId | string | Optional | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. |
email | string | Optional | The email address associated with the captive recipient. |
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. |
userName | string | Optional | The username associated with the captive recipient. |
Referenced models: Locks a template — response body — error Details
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_captiverecipients_deletecaptiverecipientspart. Catalog operation: esignature:CaptiveRecipients_DeleteCaptiveRecipientsPart. 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.