View Source DocuSign.Api.TemplateBulkRecipients (DocuSign v1.1.1)

API calls for all endpoints tagged TemplateBulkRecipients.

Summary

Functions

Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.

Functions

Link to this function

recipients_delete_template_bulk_recipients_file(connection, account_id, recipient_id, template_id, opts \\ [])

View Source
@spec recipients_delete_template_bulk_recipients_file(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.BulkRecipientsUpdateResponse.t()}
  | {:error, Tesla.Env.t()}

Deletes the bulk recipient list on a template. Deletes the bulk recipient list on a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • recipient_id (String.t): A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.BulkRecipientsUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure