Skip to content

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.

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 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_captive_recipients_delete_captive_recipients_part(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.recipientPartstringRequired within parent
bodyModelOptionalExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

Deletes the signature for one or more captive recipient records — response body
FieldTypePresenceDescription and constraints
$objectRootContains information about captive (embedded) recipients.
captiveRecipientsarrayOptionalA complex type containing information about one or more captive recipients.
captiveRecipients[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a captive (embedded) recipient.
clientUserIdstringOptionalSpecifies 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.
emailstringOptionalThe email address associated with the captive recipient.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
userNamestringOptionalThe username associated with the captive recipient.

Referenced models: 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.

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.

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.