DocuSign.Api.EnvelopeRecipients.recipients_delete_recipients
You're seeing just the function
recipients_delete_recipients
, go back to DocuSign.Api.EnvelopeRecipients module for more information.
Link to this function
recipients_delete_recipients(connection, account_id, envelope_id, opts \\ [])
View SourceSpecs
recipients_delete_recipients( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.EnvelopeRecipients.t()} | {:error, Tesla.Env.t()}
Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
- opts (KeywordList): [optional] Optional parameters
- :envelope_recipients (EnvelopeRecipients):
Returns
} on success {:error, info} on failure