v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Users

Invite new user

Invite a user to the account.

User will receive an email. The new user will receive an invitation email with a link to create an account password, the existing user will be notified about the invitation to the account.

post/iam/clients/invite_user

Request body

emailstring email required

User email.

client_idinteger required

ID of account.

lang'de' | 'en' | 'ru' | 'zh' | 'az'

User's language.

Defines language of the control panel and email messages.

namestring

User name.

Example request

{
  "user_role": {
    "id": 1,
    "name": "Administrators"
  }
}

Response

OK.

statusstring required

Status of the invitation.

user_idinteger required

Invited user ID.