Create groups

POST

/v2.1/accounts/:accountId/groups

POST

/restapi/v2.1/accounts/:accountId/groups

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/groups \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "endPosition": "sample string 1",
  "groups": [
    {
      "accessType": "sample string 1",
      "dsGroupId": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "groupId": "sample string 3",
      "groupName": "sample string 4",
      "groupType": "sample string 5",
      "isManagedByScim": true,
      "lastModifiedOn": "sample string 6",
      "permissionProfileId": "sample string 7",
      "userGroupType": "sample string 8",
      "users": [
        {
          "accountId": "sample string 1",
          "accountName": "sample string 2",
          "activationAccessCode": "sample string 3",
          "email": "sample string 4",
          "ipAddress": "sample string 5",
          "loginStatus": "sample string 6",
          "membershipId": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "uri": "sample string 9",
          "userId": "sample string 10",
          "userName": "sample string 11",
          "userStatus": "sample string 12",
          "userType": "sample string 13"
        }
      ],
      "usersCount": "sample string 9"
    }
  ],
  "nextUri": "sample string 2",
  "previousUri": "sample string 3",
  "resultSetSize": "sample string 4",
  "startPosition": "sample string 5",
  "totalSetSize": "sample string 6"
}'

{
  "endPosition": "sample string 1",
  "groups": [
    {
      "accessType": "sample string 1",
      "dsGroupId": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "groupId": "sample string 3",
      "groupName": "sample string 4",
      "groupType": "sample string 5",
      "isManagedByScim": true,
      "lastModifiedOn": "sample string 6",
      "permissionProfileId": "sample string 7",
      "userGroupType": "sample string 8",
      "users": [
        {
          "accountId": "sample string 1",
          "accountName": "sample string 2",
          "activationAccessCode": "sample string 3",
          "email": "sample string 4",
          "ipAddress": "sample string 5",
          "loginStatus": "sample string 6",
          "membershipId": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "uri": "sample string 9",
          "userId": "sample string 10",
          "userName": "sample string 11",
          "userStatus": "sample string 12",
          "userType": "sample string 13"
        }
      ],
      "usersCount": "sample string 9"
    }
  ],
  "nextUri": "sample string 2",
  "previousUri": "sample string 3",
  "resultSetSize": "sample string 4",
  "startPosition": "sample string 5",
  "totalSetSize": "sample string 6"
}

Creates one or more groups for the account.

Groups help you manage users. For example, you can use groups to limit user access to templates.

This endpoint uses only the groupName property in the request body. All other properties are ignored.

Example request:

{
  "groups": [
    { "groupName": "montagues" },
    { "groupName": "capulets" },
    { "groupName": "nobles"}
  ]
}

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: groupInformation

endPositionstringOptional

The last index position in the result set.

groupslist of objectsOptional

A collection group objects containing information about the groups.

nextUristringOptional

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.

previousUristringOptional

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.

resultSetSizestringOptional

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.

startPositionstringOptional

The starting index position of the current result set.

totalSetSizestringOptional

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

Response

Successful response.