Accounts: deleteCaptiveRecipient

This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality 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.1/accounts/{accountId}/captive_recipients/{recipientPart}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

recipientPartstring

Signature is the only supported value.

Responses

CodeDescriptionReference
200

Successful response.

captiveRecipientInformation
400

Error encountered.

errorDetails

SDK Method

Accounts::deleteCaptiveRecipient

Definitions

captiveRecipient

This object contains details about a captive (embedded) recipient.

clientUserIdstring

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.

emailstring

The email address associated with the captive recipient.

errorDetailserrorDetails

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

userNamestring

The username associated with the captive recipient.

captiveRecipientInformation

Contains information about captive (embedded) recipients.

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.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

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> 
}} />