API Reference

Remove Users and outstanding invites from a User Group

post
https://app.yoodli.ai/api/v3/orgs//hubs//users/remove

Accepts up to 100 email addresses, removes the corresponding User Group memberships.

If users would lose access to all User Groups of the Organization, they will be added to the fallback User Group.

Rate limit category: Medium API

Path Params
string
required

Organization ID.

string
required

User Group ID.

Body Params
user_emails
array of strings
required

Email addresses of the users to remove. At least one email must be specified.

user_emails*
string
required

User Group ID of the fallback. If any users who would otherwise lose access to all User Groups of the Organization, they will be added to this User Group. If the value is "default", the default User Group for the Organization will be used.

Responses

Updated 6 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 6 months ago