View Source DocuSign.Api.SigningGroupUsers (DocuSign v1.3.0)

API calls for all endpoints tagged SigningGroupUsers.

Summary

Functions

signing_groups_delete_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

Deletes one or more members from a signing group. Deletes one or more members from the specified signing group.

signing_groups_get_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group.

signing_groups_put_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

Adds members to a signing group. Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

Functions

signing_groups_delete_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

@spec signing_groups_delete_signing_group_users(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupUsers.t()}
  | {:error, Tesla.Env.t()}

Deletes one or more members from a signing group. Deletes one or more members from the specified signing group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • signing_group_id (String.t): The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
  • opts (keyword): Optional parameters
    • :body (SigningGroupUsers): A complex type that contains information about users in the signing group.

Returns

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

signing_groups_get_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

@spec signing_groups_get_signing_group_users(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupUsers.t()}
  | {:error, Tesla.Env.t()}

Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • signing_group_id (String.t): The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
  • opts (keyword): Optional parameters

Returns

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

signing_groups_put_signing_group_users(connection, account_id, signing_group_id, opts \\ [])

@spec signing_groups_put_signing_group_users(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupUsers.t()}
  | {:error, Tesla.Env.t()}

Adds members to a signing group. Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • signing_group_id (String.t): The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
  • opts (keyword): Optional parameters
    • :body (SigningGroupUsers): A complex type that contains information about users in the signing group.

Returns

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