API Reference

Add or invite Users to an Organization and its User Groups

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

Add or invite Users, up to 20 at a time, to an Organization and its User Groups.

If an invited user is already a member of the Organization, the user is added directly to the specified User Groups.

If an invited user is not a member of the Organization, the user is invited to the Organization and the specified User Groups. The user is added to the org after accepting the invite.

Rate limit category: Slow API

Path Params
string
required

Organization ID.

Body Params
emails
array of strings
required

Email addresses of the users to add or invite. At least one email must be specified.

emails*
enum
required

Pass null. Other values are reserved for Yoodli internal usage and future compatibility is not guaranteed.

Possible values:

  • org_owner – Organization Owner.
  • org_admin – Organization Administrator.
enum
required

Pass hub_member. Other values are reserved for Yoodli internal usage and future compatibility is not guaranteed.

Possible values:

  • hub_admin – User Group Administrator.
  • hub_member – User Group Member.
hub_ids
array of strings
required

User Group IDs to add or invite users to. Use default to refer to the Organization's default User Group.

hub_ids*
boolean
required

Specify whether invitation emails are sent to the invited users.

string

Optional welcome message included in invitation emails. HTML tags are stripped.

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