Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Users

Invite users

Invite a list of users with assigned roles and teams. To avoid spamming, invitation emails are not sent. Invitee will see invitation notification in-app after logging in.

post/console/v1/users/invite

Request body

rolestring required

Role assigned to the invited users. Can be 'Admin', 'Read Only', 'Member', or any custom role name.

emailsstring[] required

List of email addresses to send invitations to. Invitee Emails must have the same domain to your company email domain.

teamsstring[]

Optional list of teams that the invited users will be associated with.

Response

Invite user response

messagestring

Example response

{
  "message": "User(s) Invited successfully"
}