DocuSign.Api.EnvelopeBulkRecipients (DocuSign v0.3.4) View Source

API calls for all endpoints tagged EnvelopeBulkRecipients.

Link to this section Summary

Functions

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.

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

Adds or replaces envelope bulk recipients. Updates the bulk recipients in a draft envelope 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_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

Link to this function

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

View Source

Specs

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

Gets the bulk recipient file from an envelope. Retrieves the bulk recipient file information from an envelope 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.
  • 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
    • :include_tabs (String.t): If true include the tabs in the the result.
    • :start_position (String.t): Reserved for DocuSign.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Adds or replaces envelope bulk recipients. Updates the bulk recipients in a draft envelope 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.
  • 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
    • :bulk_recipients_request (BulkRecipientsRequest):

Returns

} on success {:error, info} on failure