Groups: update

Updates the group name and modifies, or sets, the permission profile for the group.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/groups

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Request Body

Groups

Responses

CodeDescriptionReference
200

Successful response.

Groups
400

Error encountered.

errorDetails

SDK Method

UserGroups::updateGroups

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.

group

This object contains information about a group.

errorDetailserrorDetails

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

groupIdstring

The DocuSign group ID for the group.

groupNamestring

The name of the group.

groupTypestring

The group type. Possible values include:

  • adminstrators
  • everyone
  • customGroup
  • sharedSigningGroup

permissionProfileIdstring

The ID of the permission profile associated with the group. Possible values include:

  • 2301416 (for the DocuSign Viewer profile)
  • 2301415 (for the DocuSign Sender profile)
  • 2301414 (for the Account Administrator profile)

users[userInfo]

A list of the users in the group.

usersCountstring

The total number of users in the group.

userInfo

accountIdstring

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

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

errorDetailserrorDetails

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

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

A URI containing the user ID.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

Groups

Group information

endPositionstring

The last index position in the result set.

groups[group]

A collection group objects containing information about the groups.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestring

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

Examples

Generic JSON Request/Response

Request
{
  "groups": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9"
        }
      ]
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}
Response
{
  "groups": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        }
      ],
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      }
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}
Generic XML Request/Response

Request
<groupInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 4</endPosition>
  <nextUri>sample string 5</nextUri>
  <previousUri>sample string 6</previousUri>
  <resultSetSize>sample string 1</resultSetSize>
  <startPosition>sample string 3</startPosition>
  <totalSetSize>sample string 2</totalSetSize>
  <groups>
    <group>
      <groupId>sample string 1</groupId>
      <groupName>sample string 2</groupName>
      <groupType>sample string 4</groupType>
      <permissionProfileId>sample string 3</permissionProfileId>
      <users>
        <userInfo>
          <activationAccessCode>sample string 9</activationAccessCode>
          <email>sample string 3</email>
          <loginStatus>sample string 7</loginStatus>
          <sendActivationEmail>sample string 8</sendActivationEmail>
          <uri>sample string 6</uri>
          <userId>sample string 2</userId>
          <userName>sample string 1</userName>
          <userStatus>sample string 5</userStatus>
          <userType>sample string 4</userType>
        </userInfo>
      </users>
    </group>
  </groups>
</groupInformation> 
Response
<groupInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 4</endPosition>
  <nextUri>sample string 5</nextUri>
  <previousUri>sample string 6</previousUri>
  <resultSetSize>sample string 1</resultSetSize>
  <startPosition>sample string 3</startPosition>
  <totalSetSize>sample string 2</totalSetSize>
  <groups>
    <group>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <groupId>sample string 1</groupId>
      <groupName>sample string 2</groupName>
      <groupType>sample string 4</groupType>
      <permissionProfileId>sample string 3</permissionProfileId>
      <users>
        <userInfo>
          <activationAccessCode>sample string 9</activationAccessCode>
          <email>sample string 3</email>
          <errorDetails>
            <errorCode>sample string 1</errorCode>
            <message>sample string 2</message>
          </errorDetails>
          <loginStatus>sample string 7</loginStatus>
          <sendActivationEmail>sample string 8</sendActivationEmail>
          <uri>sample string 6</uri>
          <userId>sample string 2</userId>
          <userName>sample string 1</userName>
          <userStatus>sample string 5</userStatus>
          <userType>sample string 4</userType>
        </userInfo>
      </users>
    </group>
  </groups>
</groupInformation> 
}} />