Update User Details

Updates the details of a specific user by their unique ID, including roles, offices, and divisions.

Request

Path Params

userID

integer <int32>

required

The unique identifier of the user to update.

Body Params application/json

UserID

integer <int32>

optional

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 (this is not editable).

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).

DisableContactSharing

boolean | null

optional

Indicates whether contact sharing is disabled (Professional Users only).

SummaryEmailFrequency

enum<integer> <int32>

optional

Allowed values:

012

EngagementChangeEmailType

enum<integer> <int32>

optional

Allowed values:

0116383

RequestChangeEmailType

enum<integer> <int32>

optional

Allowed values:

0124816383

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.

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

{
    "UserID": 0,
    "FirstName": "string",
    "LastName": "string",
    "Email": "string",
    "Phone": "string",
    "Mobile": "string",
    "Fax": "string",
    "Title": "string",
    "HomeOffice": "string",
    "DisableContactSharing": true,
    "SummaryEmailFrequency": 0,
    "EngagementChangeEmailType": 0,
    "RequestChangeEmailType": 0,
    "Divisions": [
        0
    ],
    "Companies": [
        0
    ],
    "Roles": [
        0
    ]
}

Request

Responses