Sign in

v2

latestSwagger 2.02026-08-04108164321.0 KB
UserProfile

Update one or more fields on an existing user. Only fields named in FieldsToUpdate are written; fields listed but null in the payload are ignored.

Admin role only. An existing user cannot change between team member and customer contact; CompanyIDFK cannot be updated. When Roles is in FieldsToUpdate, the supplied array fully replaces the existing role set (pass [] to clear) and paid-role quotas are checked against the post-update state.

put/api/UserProfile

Request body

UserIDinteger

UserID of the existing, non-archived UserProfile to update.

FieldsToUpdatestring[]

Allowlist of field names to update (case-insensitive, matches JSON keys). Other fields in the payload are ignored.

Emailstring

New email address. Must be a valid format and unique within the account. If changed, the GlobalUser link is rebuilt.

Firstnamestring

New first name. Max 100 characters.

Lastnamestring

New last name. Max 100 characters.

TimeZonestring

New Windows Time Zone ID.

PositionTitlestring

New position title. Max 100 characters.

Mobilestring

New mobile. Max 50 characters.

Phonestring

New phone. Max 50 characters.

DefaultBillableRatenumber double

New default billable rate. Team members only. Non-negative.

DefaultCostRatenumber double

New default cost rate. Team members only. Non-negative.

Rolesstring[]

When included in FieldsToUpdate, fully replaces the existing role set (pass [] to remove all). Each entry must be a RoleCode that is valid for the user's existing type (UserAssignable=1 for team members, CustomerAssignable=1 for customer contacts).

SendInviteEmailboolean

Only meaningful when Roles is in FieldsToUpdate. Drives invite-email behaviour after roles are replaced — see spec matrix.

Response

Returns the updated user.

UserIDinteger

Unique identifier for the user.

AccountIDFKinteger

The Avaza account this user belongs to.

Emailstring

User's email address.

Firstnamestring

User's first name.

Lastnamestring

User's last name.

PositionTitlestring

User's job title or position.

Phonestring

User's phone number.

Mobilestring

User's mobile phone number.

TimeZonestring

Windows Timezone ID

IANATimezonestring

IANA tz database timezone name

isTeamMemberboolean

Whether the user is an internal team member (true) or external contact (false).

CompanyIDFKinteger

The company the user is associated with (for external contacts).

CompanyNamestring

Name of the user's associated company.

DefaultBillableRatenumber double

The user's default billing rate per hour.

DefaultCostRatenumber double

The user's default cost rate per hour.

MondayAvailableHoursnumber double

Available working hours on Mondays.

TuesdayAvailableHoursnumber double

Available working hours on Tuesdays.

WednesdayAvailableHoursnumber double

Available working hours on Wednesdays.

ThursdayAvailableHoursnumber double

Available working hours on Thursdays.

FridayAvailableHoursnumber double

Available working hours on Fridays.

SaturdayAvailableHoursnumber double

Available working hours on Saturdays.

SundayAvailableHoursnumber double

Available working hours on Sundays.