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/accounts/{accountId}/signing_groups/{signingGroupId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

signingGroupIdstring

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

An error code associated with the error.

messagestring

A short error message.

signingGroupUser

emailstring

errorDetailserrorDetails

userNamestring

The name of the group member.

Maximum Length: 100 characters.

SigningGroupUsers

Signing groups' users

users[signingGroupUser]

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> 
}} />