v2

OpenAPI 3.0.02026-07-2163203194.5 KB

User

Update User Profile

Updates the user profile for the specified user within the install.

put/v1/installs/{installSid}/users/{userSid}/profile

Path parameters

installSidstring required

Install Sid

Install Sid

userSidstring required

User Sid

User Sid

Request body

currencyCodestring required

Currency Code

timeZoneSidstring required

Time Zone Sid

maxTravelDistanceUnitsstring required

Max Travel Distance Units

mobilePhonestring nullable

Mobile Phone

preferredEmailstring

Preferred Email

latitudenumber nullable

Location Latitude

longitudenumber nullable

Location Longitude

maxTravelDistancenumber nullable

Max Travel Distance

homePhonestring nullable

Home Phone

addressstring nullable

Address

smarterIdstring

SmarterID ID

smarterIdEnrollmentSidstring

SmarterID EnrollmentSid

Response

Successful

sidstring nullable

User SID

firstNamestring nullable

First name

lastNamestring nullable

Last name

emailstring nullable

Email

preferredEmailstring nullable

Preferred email

usernamestring nullable

Username

smarterIdEnrollmentSidstring nullable

SmarterID enrollment SID

mobilePhonestring nullable

Mobile phone

homePhonestring nullable

Home phone

addressstring nullable

Address

lmsIdstring nullable

LMS ID

apiIdstring nullable

API ID

sisIdstring nullable

SIS ID

externalIdstring nullable

External ID

latitudenumber nullable

Latitude

longitudenumber nullable

Longitude

lastEnrollmentSyncstring nullable

Last enrollment sync

currencyCodestring nullable

Currency code

timeZoneSidstring nullable

Time zone SID

timezoneTimezone nullable

Timezone details

maxTravelDistancenumber nullable

Max travel distance

maxTravelDistanceUnitsstring nullable

Max travel distance units

createdDatestring nullable

Created date

editDatestring nullable

Edit date

freshdeskUserIdstring nullable

Freshdesk user ID

rolestring nullable

Role

enabledboolean nullable

Enabled

authenticationAuthentication nullable

Authentication data

smarterIdSmarterId nullable

SmarterID data

courseModel28 nullable

Course

examModel29 nullable

Exam

identityIdentity nullable

Identity