Create Users

POST

/api/public/users

Users

Creates one or more new users with the specified attributes, roles, offices, and divisions.

Each user must have at least one associated office and role.

Request

Body Params application/json

array of:

IsClient

boolean

optional

Indicates if the user is a professional or client. Set to true for client users, false for professional users.
Professional users consume licenses and have different workflows from clients.

FirstName

string | null

optional

The user's first name (maximum 100 characters).

LastName

string | null

optional

The user's last name (maximum 100 characters).

string | null

optional

The user's email address (must be unique).

Phone

string | null

optional

Phone number (maximum 25 characters).

Mobile

string | null

optional

Mobile number (maximum 25 characters).

Fax

string | null

optional

Fax number (maximum 25 characters).

Title

string | null

optional

Job title (maximum 100 characters).

HomeOffice

string | null

optional

Home office location (maximum 100 characters).

Divisions

array[integer <int32>] | null

optional

List of division IDs. Required for professional users. The main division is always ID 1000.

Companies

array[integer <int32>] | null

optional

List of company IDs. Each user must be assigned at least one company ID.

The firm company ID is always 100.

Client company IDs start at 1000.

Offices

array[integer <int32>] | null

optional

Optional. List of office IDs for the user. If not provided, the main office for the company in Companies will be used.

Roles

array[integer <int32>] | null

optional

List of role IDs. Each user must be assigned at least one global role.
If not provided, the General role will be assigned.

Professional Roles

1000 - Administrator: Full system access.

1020 - Staff Manager: Add or remove users from the system.

1030 - Engagement Admin: Create, manage, and delete all engagements.

1035 - Engagement Manager: Manage engagements they are a part of.

Client Roles

1010 - Client Manager: Manage client companies and users.

Professional or Client Roles

1049 - General: Read engagements and respond to requests.

Example

[
    {
        "IsClient": true,
        "FirstName": "string",
        "LastName": "string",
        "Email": "string",
        "Phone": "string",
        "Mobile": "string",
        "Fax": "string",
        "Title": "string",
        "HomeOffice": "string",
        "Divisions": [
            0
        ],
        "Companies": [
            0
        ],
        "Offices": [
            0
        ],
        "Roles": [
            0
        ]
    }
]

Responses

🟢201Created

Created: Users were successfully created.

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠409409

🔴500Server Error

Modified at 2025-03-24 12:24:39

Get Users by Status

Update Multiple Users