DocuSign.Api.TemplateBulkRecipients (DocuSign v0.3.3) View Source

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.

Adds or replaces the bulk recipients list in a template. Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

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

Specs

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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

recipients_get_template_bulk_recipients(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.TemplateBulkRecipients.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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :include_tabs (String.t): When set to true, the tab information associated with the recipient is included in the response.
    • :start_position (String.t): Reserved for DocuSign.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Adds or replaces the bulk recipients list in a template. Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :bulk_recipients_request (BulkRecipientsRequest):

Returns

} on success {:error, info} on failure