Sign in
Groups

Deletes an existing user group.

Deletes an existing user group.

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

Example:

{
  "groups": [
    {
      "groupId": "12345"
    }
}
delete/v2.1/accounts/{accountId}/groups

Path parameters

accountIdstring required

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

Request body

endPositionstring

The last index position in the result set.

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.

Response

Successful response.

Changes

No recorded changes to this endpoint across all 39 revisions of this API.