Accounts: deleteCaptiveRecipient

Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.

Request

HTTP request

DELETE /v2/accounts/{accountId}/captive_recipients/{recipientPart}

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

recipientPart string

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::deleteCaptiveRecipient

Definitions Expand All | Collapse All

captiveRecipient

clientUserId string

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.

Note: 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.

Maximum length: 100 characters.

email string

Specifies the email address associated with the captive recipient.

errorDetails errorDetails
userName string

Specifies the user name associated with the captive recipient.

captiveRecipientInformation

captiveRecipients
[captiveRecipient]

A complex type containing information about one or more captive recipients.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Request/Response

Request

{
"captiveRecipients": [
{
"email": "sample string 1",
"userName": "sample string 2",
"clientUserId": "sample string 3"
}
]
}

Response

{
"captiveRecipients": [
{
"email": "sample string 1",
"userName": "sample string 2",
"clientUserId": "sample string 3",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}
]
}

Generic XML Request/Response

Request

<captiveRecipientInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<captiveRecipients>
<captiveRecipient>
<clientUserId>sample string 3</clientUserId>
<email>sample string 1</email>
<userName>sample string 2</userName>
</captiveRecipient>
</captiveRecipients>
</captiveRecipientInformation>

Response

<captiveRecipientInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<captiveRecipients>
<captiveRecipient>
<clientUserId>sample string 3</clientUserId>
<email>sample string 1</email>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<userName>sample string 2</userName>
</captiveRecipient>
</captiveRecipients>
</captiveRecipientInformation>