DocuSign Momentum 2018DocuSign Momentum 2018

Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent.

After using this, the bulkRecipientsUri property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.

Request

HTTP request

DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

recipientIdstring

The recipientId used when the envelope or template was created.

Responses

CodeDescriptionReference
200

Successful response.

bulkRecipientsUpdateResponse
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::deleteRecipients

Definitions

addressInformation
addressInformationInput
approve
authenticationStatus
bulkRecipientsUpdateResponse
checkbox
company
date
dateSigned
decline
dobInformationInput
documentVisibility
email
emailAddress
envelopeId
errorDetails
eventResult
firstName
formulaTab
fullName
idCheckInformationInput
initialHere
lastName
list
listItem
mergeField
money
notarize
note
number
paymentDetails
paymentLineItem
propertyMetadata
radio
radioGroup
recipientAttachment
recipientEmailNotification
recipientPhoneAuthentication
recipientSAMLAuthentication
recipientSignatureInformation
recipientSignatureProvider
recipientSignatureProviderOptions
recipientSMSAuthentication
samlAssertionAttribute
signer
signerAttachment
signHere
socialAuthentication
ssn
ssn4InformationInput
ssn9InformationInput
text
title
userInfo
view
zip
EnvelopeRecipientTabs

Examples

Generic JSON Response
Generic XML Response