Create or delete a custom user group via API

Custom user groups are groups that you can create and manage via the Learn365 API. Unlike Microsoft Entra groups, custom user groups can include users of any type, both Learn365 and Flow365. 

 

Create custom user groups

To create a custom user group via API:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Groups section, select the POST /services/users/Groups endpoint and select Try it out in the top right-hand corner.

3. In the request body, enter the title string parameter. The title must be unique, meaning it can’t belong to an existing custom user group or Microsoft Entra group. To see a list of existing custom user groups and Microsoft Entra groups, send the GET /services/users/Groups API request.

4. Select Execute to run the request.

5. Go to the Response block to check the results:

  • 200 code with the group id and title in the response body indicates a successful response.
  • In case of errors, the response body contains the error object with the code and message keys explaining the issue.

 

Delete custom user groups

To delete a custom group via API, you’ll need the group ID. There are two ways to find this:

To delete a custom user group via API:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Groups section, select the DELETE /services/users/Groups/{groupId} endpoint and select Try it out in the top right-hand corner.

3. Enter the ID of the user group in the groupId field.

4. Select Execute to run the request.

5. Go to the Response block to check the results:

  • 200 code with the group id and title in the response body indicates a successful response.
  • In case of errors, the response body contains the error object with the code and message keys explaining the issue.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.