API Reference

Delete a User Group

delete
https://app.yoodli.ai/api/v3/orgs//hubs/

Deletes a User Group from an Organization.

The default User Group cannot be deleted.

Members who belong only to the deleted User Group can either be:

  • Transferred to the default User Group (when transfer=true)
  • Removed from the Organization entirely (when transfer=false or omitted)

Rate limit category: Medium API

Path Params
string
required

Organization ID.

string
required

User Group ID. Cannot be default as the default User Group cannot be deleted.

Query Params
string
enum

Determine whether the users who belong only to the deleted User Group are transferred to the default User Group or are removed from the Organization entirely.

Possible values:

  • true – Represents a true boolean value.
  • false – Represents a false boolean value.
Allowed:
Responses
204

The User Group was deleted successfully.

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago