Update a user

patch

https://{tenant}{.kallidus-suite.com}/api/v4/suite/users({userIdentifier})

Update some or all details for an existing user. Only the fields provided are changed.

Path Params

userIdentifier

string

required

The user's ID (guid) (e.g., b48737b7-62ac-421b-9c12-3c1014dd07b7)

Body Params

Partial user update. If both startDate and leaveDate are provided, startDate must be earlier than leaveDate.

username

string

length ≤ 100

^\S+$

givenName

string

length ≤ 50

familyName

string

length ≤ 50

preferredName

string

dateOfBirth

date

Date of birth in YYYY-MM-DD format

emailAddress

string | null

ccEmailAddress

string | null

mobileNumber

string

culture

string

department

string

division

string

companyName

string

managerType

string

preferredTrainingLocation

string

location

string

region

string

roles

object

costCenter

string

payGrade

string

payrollNumber

string

contractType

string

employeeCategory

string

isEnabled

boolean

startDate

date | null

Start date of employment in YYYY-MM-DD format

leaveDate

date | null

End date of employment in YYYY-MM-DD format

isAbsent

boolean

isFireWarden

boolean

isFirstAider

boolean

brandId

uuid | null

The ID of the brand to assign to the user. Set to null to revert to the system default.

primaryJobProfileId

uuid | null

The ID of the primary job profile to assign to the user. Set to null to clear the user's primary job profile.

primaryGroupId

uuid | null

The ID of the group to set as the user's primary group. Set to null to clear the primary group.

additionalJobProfileIds

array of uuids | null

The IDs of the user's job profiles other than the primary. Omit to leave the user's existing additional job profiles unchanged. Set to null or to an empty array to remove them all. When populated, replaces the collection entirely - any job profile not listed is unassigned. No ID may refer to the user's primary job profile, and no ID may appear more than once.

additionalJobProfileIds

userInformationFields

object

Responses

204

User patched successfully

400Bad Request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

500Internal Server Error