latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

users

Invite multiple users to the team

Invites one or more users to the team and creates all associated resources (user accounts, phone numbers, voicemail, etc.). Each invited user receives an activation email. This operation consumes available licences from your subscription plan — ensure you have enough licences before calling this endpoint.

Permission: No specific permission required. A valid API key is sufficient.

Monitoring: Not needed.

Warning — Sensitive operation: This route does not enforce any specific permission category. Any valid API key can invite new users to the team, consuming licences and generating activation emails. Consider restricting API key distribution to prevent unauthorized user creation.

post/users/invite

Request body

invited_byinteger

(optional) id of the user initiating the invitation

Example request

{
  "users": [
    {
      "email": "myemail@domain",
      "firstname": "John",
      "lastname": "Doe"
    }
  ]
}

Response

Successful operation

idinteger
emailstring
firstnamestring
lastnamestring
is_adminboolean
is_billingboolean
is_supervisor_currentscallsboolean
is_supervisor_logsboolean
is_supervisor_statsboolean
is_supervisor_campaignboolean
is_technicalboolean
plan_idinteger
plan_namestring
superadminboolean
user_statusstring
avatarstring
adminstring
waitingboolean