Sign in

v1

Swagger 2.02026-07-13107162315.5 KB
UserProfile

Create a new user (team member or customer contact) in the current Avaza account.

Admin role only. If CompanyIDFK is provided the user is created as a Customer Contact, otherwise as a Team Member. Paid-role seat quotas are enforced. If Email already exists in the central GlobalUser table the new UserProfile is linked to that GlobalUser, otherwise a new GlobalUser is created.

post/api/UserProfile

Request body

Emailstring

Email address. Must be a valid format and unique within the current account.

Firstnamestring

First name. Max 100 characters.

Lastnamestring

Last name. Max 100 characters.

TimeZonestring

Windows Time Zone ID (e.g. "Pakistan Standard Time"). If omitted, defaults to the account's timezone.

CompanyIDFKinteger

If set, creates a Customer Contact linked to this Company. If null, creates a Team Member.

PositionTitlestring

User's job title. Max 100 characters.

Mobilestring

Mobile phone number. Max 50 characters.

Phonestring

Phone number. Max 50 characters.

DefaultBillableRatenumber double

Default billable rate per hour. Team members only. Must be non-negative.

DefaultCostRatenumber double

Default cost rate per hour. Team members only. Must be non-negative.

Rolesstring[]

Role codes to assign. Each entry must be a RoleCode from the Roles table that is assignable for the user type (UserAssignable=1 for team members, CustomerAssignable=1 for customer contacts). Empty/null = no roles (InvitationStatusCode = "NoRoles").

SendInviteEmailboolean

If true and at least one role is assigned, sends an invitation email and sets InvitationStatusCode = "InviteSent". See spec for the full matrix.

Response

Returns the created 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.