Sign in

v1

Swagger 2.02026-07-13107162315.5 KB
UserProfile

Archive an existing user. Sets isArchived=true, deletes all role assignments, and disables all ProjectMember rows (freeing any consumed paid-role seats).

Admin role only. Archiving an already-archived user is a no-op and returns the current record. You cannot archive yourself.

post/api/UserProfile/Archive

Request body

UserIDinteger

UserID of the existing UserProfile to archive or unarchive.

Response

Returns the archived user (IsArchived = true).

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.