DocuSign.Api.EnvelopeBulkRecipients.recipients_delete_bulk_recipients_file

You're seeing just the function recipients_delete_bulk_recipients_file, go back to DocuSign.Api.EnvelopeBulkRecipients module for more information.
Link to this function

recipients_delete_bulk_recipients_file(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

recipients_delete_bulk_recipients_file(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.BulkRecipientsUpdateResponse.t()}
  | {:error, Tesla.Env.t()}

Deletes the bulk recipient file from an envelope. 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.

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
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure