Groups

Deletes an existing user group

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

Deletes an existing user group.

When you delete a group, you include only the groupId in the request body.

Example:

{  "groups": [    {      "groupId": "12345"    }}

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2.1/accounts/string/groups"
{  "endPosition": "string",  "groups": [    {      "accessType": "string",      "dsGroupId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "groupId": "string",      "groupName": "string",      "groupType": "string",      "isManagedByScim": true,      "lastModifiedOn": "string",      "permissionProfileId": "string",      "userGroupType": "string",      "users": [        {          "accountId": "string",          "accountName": "string",          "activationAccessCode": "string",          "email": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "ipAddress": "string",          "loginStatus": "string",          "membershipId": "string",          "sendActivationEmail": "string",          "uri": "string",          "userId": "string",          "userName": "string",          "userStatus": "string",          "userType": "string"        }      ],      "usersCount": "string"    }  ],  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}

Creates one or more groups for the account POST

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. You can associate a group with a [permission profile](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/permissions/), which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set permission profiles for a group, but it makes it easier to manage user permissions for a large number of users. <ds-inlinemessage kind="warning" markdown="1"> This endpoint uses only the <code>groupName</code> and <code>permissionProfileId</code> properties in the request body. All other properties are ignored. </ds-inlinemessage> Example request: ```json { "groups": [ { "groupName": "montagues" }, { "groupName": "capulets" }, { "groupName": "nobles", "permissionProfileId": 1597 } ] } ``` Use [AccountPermissionProfiles: list](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. It is an error if the `permissionProfileId` does not exist. ### Related topics - [How-To Set Up a Permission Profile](https://developers.docusign.com/docs/esign-rest-api/how-to/permission-profile-setting/)

Updates the group information for a group PUT

Updates the group name and modifies, or sets, the permission profile for the group. ### Related topics - [How-To Set Up a Permission Profile](https://developers.docusign.com/docs/esign-rest-api/how-to/permission-profile-setting/)