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

API calls for all endpoints tagged TemplateBulkRecipients.

Link to this section Summary

Functions

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

Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.

Link to this section 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

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

Returns

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

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

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

Gets the bulk recipient file from a template. Retrieves the bulk recipient file information from a template that has a bulk recipient.

parameters

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
    • :include_tabs (String.t): When true, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (false).
    • :start_position (String.t): The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.

returns

Returns

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