DocuSign.Api.EnvelopeRecipients.recipients_delete_recipient

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

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

View Source

Specs

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

Deletes a recipient from an envelope. Deletes a recipient from a `draft` or `sent` envelope. If the envelope is "In Process" (has been sent and is not 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
  • 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