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

Request

HTTP request

PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

signingGroupIdstring

Optional. 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, we recommend 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 the default action of Needs to Sign to a different value, such as Receives a Copy.

Request Body

SigningGroupUsers

Responses

CodeDescriptionReference
200

Successful response.

SigningGroupUsers
400

Error encountered.

errorDetails

SDK Method

SigningGroups::updateUsers

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

signingGroupUser

emailstring

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

userNamestring

The name of the group member.

Maximum Length: 100 characters.

SigningGroupUsers

Signing groups' users

users[signingGroupUser]

User management information.

Examples

Generic JSON Request/Response

Request
{
  "users": [
    {
      "userName": "sample string 1",
      "email": "sample string 2"
    }
  ]
}
Response
{
  "users": [
    {
      "userName": "sample string 1",
      "email": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Request/Response

Request
<signingGroupUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <users>
    <signingGroupUser>
      <email>sample string 2</email>
      <userName>sample string 1</userName>
    </signingGroupUser>
  </users>
</signingGroupUsers> 
Response
<signingGroupUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <users>
    <signingGroupUser>
      <email>sample string 2</email>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <userName>sample string 1</userName>
    </signingGroupUser>
  </users>
</signingGroupUsers> 
}} />