v1
latestSwagger 2.02026-07-134146194.6 MBGroups
Creates one or more groups for the account.
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, 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:
{
"groups": [
{ "groupName": "montagues" },
{ "groupName": "capulets" },
{ "groupName": "nobles",
"permissionProfileId": 1597 }
]
}
Use 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
post/v2.1/accounts/{accountId}/groups
Path parameters
accountIdstring required
The external account number (int) or account ID GUID.
Request body
Response
Successful response.