Add a user to my business

QA Environment

https://qa-api.kiolinkapp.com

POST

/v1/my-businessusers

My Business Users

Last modified:2026-10-05 22:26:47

Maintainer:Not configured

Required Permission(s):mybusiness-users-create

Creates a user in the signed-in business user's business, or reactivates it if the email already belongs to this business. A welcome email with a link to set the password is sent when the address is deliverable (or unknown), and the action is recorded.

Every body value must be a string (they are trimmed); arrays and objects cause HTTP 500.

An email that belongs to another business returns HTTP 200 with { "message": "Error", "error": 11000 }.

Acts on the signed-in business user and their business. KIO users get HTTP 500.

Requires a session token whose role has the mybusiness-users-create permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Body Params application/jsonRequired

Example

{
  "firstname": "Luis",
  "lastname": "Martínez",
  "email": "luis.martinez@example.com",
  "role": "65f1c2a9e4b0a1b2c3d4e5b3",
  "level": "Operador"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/my-businessusers' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "firstname": "Luis",
  "lastname": "Martínez",
  "email": "luis.martinez@example.com",
  "role": "65f1c2a9e4b0a1b2c3d4e5b3",
  "level": "Operador"
}'

Responses

🟢200The created or reactivated user

application/json

The created or reactivated user. An email of another business is also reported with this status.

Bodyapplication/json

Examples

SuccessEmail of another business

{
    "_id": "65f1c2a9e4b0a1b2c3d4e5f7",
    "firstname": "Luis",
    "lastname": "Martínez",
    "email": "luis.martinez@example.com",
    "devices": [],
    "device_tokens": [],
    "consoles": [],
    "active": true,
    "role": "65f1c2a9e4b0a1b2c3d4e5b3",
    "business": "65f1c2a9e4b0a1b2c3d4e5a1",
    "created_at": "2025-05-01T18:00:00.000Z",
    "level": "Operador",
    "verify_email": "deliverable",
    "delete_request": false,
    "id_service_desk_plus": "0",
    "two_factor_auth_activated": false,
    "two_factor_auth_unavailable": false,
    "sent_feedback": false,
    "__v": 0
}

🟠400`email` is missing or has an invalid format

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error (e

Modified at 2026-10-05 22:26:47

List my business's users

Get a user of my business