API: updateUser

14 Minutes to read

Print
Share
Dark
Light

API: updateUser

14 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Starting June 1, 2022, SmarterU will require all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
Tags are required unless specified.

Description

The updateUser method edits a user.

If the user being updated exists over multiple SmarterU accounts, Given Name, Surname, Email, Password cannot be modified by default. If you need to edit users who are in multiple accounts, please contact our Success Desk.
Administrators and owners cannot be updated through the API.

Who Has Access

The following users have access to the createUser method:

Users with the Group Manager, Manage Group Users, or Manage Users group permission.
Supervisors, if the account's Supervisor Access setting'sView Supervisees or Edit Supervisees option is checked.
Administrators and owners.

API Call XML Package

<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>updateUser</Method>
   <Parameters>
      <User>
         <Identifier>
            <Email><![CDATA[]]></Email>
               - OR -
            <EmployeeID><![CDATA[]]></EmployeeID>
         </Identifier>

         <Info>
            <Email><![CDATA[]]></Email>
            <EmployeeID><![CDATA[]]></EmployeeID>
            <GivenName><![CDATA[]]></GivenName>
            <Surname><![CDATA[]]></Surname>
            <Password><![CDATA[]]></Password>
            <Timezone><![CDATA[]]></Timezone>
            <LearnerNotifications><![CDATA[]]></LearnerNotifications>
            <SupervisorNotifications><![CDATA[]]></SupervisorNotifications>
            <SendEmailTo><![CDATA[]]></SendEmailTo>
            <AlternateEmail><![CDATA[]]></AlternateEmail>
            <AuthenticationType><![CDATA[]]></AuthenticationType>
         </Info>
         
         <Profile>
            <Supervisors>
               <Supervisor>
                  <SupervisorEmail><![CDATA[]]></SupervisorEmail>
                  <SupervisorAction><![CDATA[]]></SupervisorAction>
               </Supervisor>
            </Supervisors>
   
            <Organization><![CDATA[]]></Organization>

            <Teams>
               <Team>
                  <TeamName><![CDATA[]]></TeamName>
                  <TeamAction><![CDATA[]]></TeamAction>
               </Team>
            </Teams>
            
            <CustomFields>
               <CustomField>
                  <CustomFieldName><![CDATA[]]></CustomFieldName>
                  <CustomFieldValue><![CDATA[]]></CustomFieldValue>
               </CustomField>
            </CustomFields>
            
            <Language><![CDATA[]]></Language>
            <Status><![CDATA[]]></Status>
            <Title><![CDATA[]]></Title>
            <Division><![CDATA[]]></Division>
            <AllowFeedback><![CDATA[]]></AllowFeedback>
            <PhonePrimary><![CDATA[]]></PhonePrimary>
            <PhoneAlternate><![CDATA[]]></PhoneAlternate>
            <PhoneMobile><![CDATA[]]></PhoneMobile>
            <Fax><![CDATA[]]></Fax>
            <Website><![CDATA[]]></Website>
            <Address1><![CDATA[]]></Address1>
            <Address2><![CDATA[]]></Address2>
            <City><![CDATA[]]></City>
            <Province><![CDATA[Manitoba]]></Province>
            <Country><![CDATA[Canada]]></Country>
            <PostalCode><![CDATA[]]></PostalCode>
            <SendMailTo><![CDATA[]]></SendMailTo>

            <Roles>
               <Role>
                  <RoleName><![CDATA[]]></RoleName>
                     - OR -
                  <RoleID><![CDATA[]]></RoleID>
                     <RoleAction><![CDATA[]]></RoleAction>
                  </Role>
            </Roles>
            <ReceiveNotifications><![CDATA[]]></ReceiveNotifications>
            <HomeGroup><![CDATA[]]></HomeGroup>
         </Profile>
           
         <Groups>
            <Group>
               <GroupName><![CDATA[]]></GroupName>
                  - OR -
               <GroupID><![CDATA[]]></GroupID>
               <GroupAction><![CDATA[]]></GroupAction>
               <GroupPermissions>
                  <Permission>
                     <Action><![CDATA[]]></Action>
                     <Code><![CDATA[]]></Code>
                  </Permission>
               </GroupPermissions>
            </Group>
         </Groups>
         
         <Venues>
            <Venue>
               <VenueName><![CDATA[]]></VenueName>
               <Visibility><![CDATA[]]></Visibility>
               <AutoWaitingList><![CDATA[]]></AutoWaitingList>
            </Venue>
         </Venues>

         <Wages>
            <Wage>
               <WageID><![CDATA[]]></WageID>
               <WageAction><![CDATA[]]></WageAction>
               <EffectiveDate><![CDATA[]]></EffectiveDate>
               <HourlyWage><![CDATA[]]></HourlyWage>
            </Wage>
         </Wages>

      </User>
  
   </Parameters>
</SmarterU>

The Identifier tag within the User tag group contains the information for the user you want to update. The following tags are required even if they don't contain any tags:

Info
Profile
Groups

The User tag group is a container for the user's details.

<User>
   <Identifier>
      <Email><![CDATA[]]></Email>
         - OR -
      <EmployeeID><![CDATA[]]></EmployeeID>
   </Identifier>

   <Info>
      <Email><![CDATA[]]></Email>
      <EmployeeID><![CDATA[]]></EmployeeID>
      <GivenName><![CDATA[]]></GivenName>
      <Surname><![CDATA[]]></Surname>
      <Password><![CDATA[]]></Password>
      <Timezone><![CDATA[]]></Timezone>
      <LearnerNotifications><![CDATA[]]></LearnerNotifications>
      <SupervisorNotifications><![CDATA[]]></SupervisorNotifications>
      <SendEmailTo><![CDATA[]]></SendEmailTo>
      <AlternateEmail><![CDATA[]]></AlternateEmail>
      <AuthenticationType><![CDATA[]]></AuthenticationType>
   </Info>
         
   <Profile>
      <Supervisors>
         <Supervisor>
            <SupervisorEmail><![CDATA[]]></SupervisorEmail>
            <SupervisorAction><![CDATA[]]></SupervisorAction>
         </Supervisor>
      </Supervisors>
   
      <Organization><![CDATA[]]></Organization>

      <Teams>
         <Team>
            <TeamName><![CDATA[]]></TeamName>
            <TeamAction><![CDATA[]]></TeamAction>
         </Team>
      </Teams>
            
      <CustomFields>
         <CustomField>
            <CustomFieldName><![CDATA[]]></CustomFieldName>
            <CustomFieldValue><![CDATA[]]></CustomFieldValue>
         </CustomField>
      </CustomFields>
            
      <Language><![CDATA[]]></Language>
      <Status><![CDATA[]]></Status>
      <Title><![CDATA[]]></Title>
      <Division><![CDATA[]]></Division>
      <AllowFeedback><![CDATA[]]></AllowFeedback>
      <PhonePrimary><![CDATA[]]></PhonePrimary>
      <PhoneAlternate><![CDATA[]]></PhoneAlternate>
      <PhoneMobile><![CDATA[]]></PhoneMobile>
      <Fax><![CDATA[]]></Fax>
      <Website><![CDATA[]]></Website>
      <Address1><![CDATA[]]></Address1>
      <Address2><![CDATA[]]></Address2>
      <City><![CDATA[]]></City>
      <Province><![CDATA[Manitoba]]></Province>
      <Country><![CDATA[Canada]]></Country>
      <PostalCode><![CDATA[]]></PostalCode>
      <SendMailTo><![CDATA[]]></SendMailTo>

      <Roles>
         <Role>
            <RoleName><![CDATA[]]></RoleName>
               - OR -
            <RoleID><![CDATA[]]></RoleID>
            <RoleAction><![CDATA[]]></RoleAction>
         </Role>
      </Roles>
      <ReceiveNotifications><![CDATA[]]></ReceiveNotifications>
      <HomeGroup><![CDATA[]]></HomeGroup>
   </Profile>
           
   <Groups>
      <Group>
         <GroupName><![CDATA[]]></GroupName>
            - OR -
         <GroupID><![CDATA[]]></GroupID>
         <GroupAction><![CDATA[]]></GroupAction>
         <GroupPermissions>
            <Permission>
               <Action><![CDATA[]]></Action>
               <Code><![CDATA[]]></Code>
            </Permission>
         </GroupPermissions>
      </Group>
   </Groups>
         
   <Venues>
      <Venue>
         <VenueName><![CDATA[]]></VenueName>
         <Visibility><![CDATA[]]></Visibility>
         <AutoWaitingList><![CDATA[]]></AutoWaitingList>
      </Venue>
   </Venues>

   <Wages>
      <Wage>
         <WageID><![CDATA[]]></WageID>
         <WageAction><![CDATA[]]></WageAction>
         <EffectiveDate><![CDATA[]]></EffectiveDate>
         <HourlyWage><![CDATA[]]></HourlyWage>
      </Wage>
   </Wages>

</User>

The User tag may contain the following.

The Identifier tag contains the information for the user you want to update. The remaining tags in the Users tag group specify the updates to the user.

Identifier

The identifier of the user you want to update. This tag contains the following.

Tag	Description
Email	The user's email address. This tag is mutually exclusive with the EmployeeID tag. This is the Email returned by the getUser and listUsers methods.
EmployeeID	The user's employee ID. This tag is mutually exclusive with the Email tag. This is the EmployedID returned by the getUser and listUsers methods.

Info

A container for the user's login information. Refer to Info Tag Group.

The Info tag is required even if it doesn't contain any tags.

<Info>
</Info>

Profile

A container for the user's profile information. Refer to Profile Tag Group.

The Profile tag is required even if it doesn't contain any tags.

<Profile>
</Profile>

Groups

A container for the user's groups and group permissions. Refer to Groups Tag Group.

The Groups tag is required even if it doesn't contain any tags.

<Groups>
</Groups>

Venues

A container for the user's venues. Refer to Venues Tag Group.

Wages

A container for the user's wages. Refer to Wages Tag Group.

The Info tag group is a container for the user's login information.

<Info>
   <Email><![CDATA[]]></Email>
   <EmployeeID><![CDATA[]]></EmployeeID>
   <GivenName><![CDATA[]]></GivenName>
   <Surname><![CDATA[]]></Surname>
   <Password><![CDATA[]]></Password>
   <Timezone><![CDATA[]]></Timezone>
   <LearnerNotifications><![CDATA[]]></LearnerNotifications>
   <SupervisorNotifications><![CDATA[]]></SupervisorNotifications>
   <SendEmailTo><![CDATA[]]></SendEmailTo>
   <AlternateEmail><![CDATA[]]></AlternateEmail>
   <AuthenticationType><![CDATA[]]></AuthenticationType>
</Info>

The Info tag may contain the following.

Email (optional)

The user's email address.

EmployeeID (optional)

The user's employee ID. This must be a unique value between all users in your SmarterU account.

GivenName (optional)

The user's first name.

Surname (optional)

The user's last name.

Password (optional)

The user's password. The password must comply with the account's password requirements. If no password is provided, a random password will be generated for the user. Regardless of whether a random password is generated or one is provided, the user must change their password the next time they log in (if Single Sign On is not used).

TimeZone (optional)

The user's primary time zone.

Acceptable values are the values listed in the Provided Name column on the Time Zones page.

If you update the timezone while the user is logged in, they will need to log out and log back in for the change to take effect.

LearnerNotifications (optional)

Indicates whether the user should receive weekly reminders of their pending or outstanding courses in SmarterU:

1 - The user will receive weekly reminders.
0 - The user will not receive weekly reminders.

SupervisorNotifications (optional)

Indicates whether the user should receive weekly reports on the status of their supervisees:

1 - The user will receive weekly reports on their supervisees.
0 - The user will not receive weekly reports on their supervisees.

SendEmailTo (optional)

Indicates where the user's emails should be sent:

Supervisor - Emails to the user will be sent to the supervisors' email addresses. If the user has multiple supervisors, emails will be sent to all of the user's supervisors. A supervisor must have a primary email address specified for this option to be allowed.
Self - Emails to the user are sent to the user's primary email address. An email address must be provided for this option to be allowed.
Alternate - Emails to the user will be sent to the email address specified in the AlternateEmail tag. For this option to be allowed, a valid email address must be provided in the AlternateEmail tag.

AlternateEmail

The user's alternate email address.

AuthenticationType (optional)

Indicates how you would like the user to authenticate:

SmarterU - The user will log into SmarterU via the SmarterU interface.
External - The user will log into SmarterU via an external system using single-sign on.
Both - The user will log into SmarterU via the SmarterU interface or an external system.

A container for the user's profile information.

The Profile tag group is required even if doesn't contain any tags.

<Profile>
   <Supervisors>
      <Supervisor>
         <SupervisorEmail><![CDATA[]]></SupervisorEmail>
         <SupervisorAction><![CDATA[]]></SupervisorAction>
      </Supervisor>
   </Supervisors>

   <Organization><![CDATA[]]></Organization>

   <Teams>
       <Team>
          <TeamName><![CDATA[]]></TeamName>
          <TeamAction><![CDATA[]]></TeamAction>
       </Team>
    </Teams>
 
    <CustomFields>
       <CustomField>
          <CustomFieldName><![CDATA[]]></CustomFieldName>
          <CustomFieldValue><![CDATA[]]></CustomFieldValue>
       </CustomField>
    </CustomFields>
 
   <Language><![CDATA[]]></Language>
   <Status><![CDATA[]]></Status>
   <Title><![CDATA[]]></Title>
   <Division><![CDATA[]]></Division>
   <AllowFeedback><![CDATA[]]></AllowFeedback>
   <PhonePrimary><![CDATA[]]></PhonePrimary>
   <PhoneAlternate><![CDATA[]]></PhoneAlternate>
   <PhoneMobile><![CDATA[]]></PhoneMobile>
   <Fax><![CDATA[]]></Fax>
   <Website><![CDATA[]]></Website>
   <Address1><![CDATA[]]></Address1>
   <Address2><![CDATA[]]></Address2>
   <City><![CDATA[]]></City>
   <Province><![CDATA[Manitoba]]></Province>
   <Country><![CDATA[Canada]]></Country>
   <PostalCode><![CDATA[]]></PostalCode>
   <SendMailTo><![CDATA[]]></SendMailTo>

   <Roles>
      <Role>
         <RoleName><![CDATA[]]></RoleName>
            - OR -
         <RoleID><![CDATA[]]></RoleID>
         <RoleAction><![CDATA[]]></RoleAction>
      </Role>
   </Roles>

   <ReceiveNotifications><![CDATA[]]></ReceiveNotifications>
   <HomeGroup><![CDATA[]]></HomeGroup>
</Profile>

The Profile tag may contain the following.

Supervisors (optional)

A container for the user's supervisors.

<Supervisors>
   <Supervisor>
      <SupervisorEmail><![CDATA[]]></SupervisorEmail>
      <SupervisorAction><![CDATA[]]></SupervisorAction>
   </Supervisor>
</Supervisors>

Each supervisor is contained in a Supervisor tag and contains the following.

Tag	Description
SupervisorEmail	The supervisor's email address.
SupervisorAction	Indicates whether the supervisor is to be added or removed from the user: Add - Adds the supervisor to the user. Remove - Removes the supervisor from the user.

Organization (optional)

The name of the user's organization.

Teams (optional)

A container for the user's teams.

<Teams>
   <Team>
      <TeamName><![CDATA[]]></TeamName>
      <TeamAction><![CDATA[]]></TeamAction>
   </Team>
</Teams>

Each team is contained in a Team tag and contains the following.

Tag	Description
TeamName	The team's name.
TeamAction	Indicates whether the team is to be added or removed from the user: Add - Adds the team to the user. Remove - Removes the team from the user.

CustomFields (optional)

A container for the account's custom user fields.

<CustomFields>
   <CustomField>
      <CustomFieldName><![CDATA[]]></CustomFieldName>
      <CustomFieldValue><![CDATA[]]></CustomFieldValue>
   </CustomField>
</CustomFields>

Each custom field is contained in a CustomField tag and contains the following.

Tag	Description
CustomFieldName	The custom user field's name.
CustomFieldValue	The value to assign to the custom user field. To specify the values for a hierarchical custom user field, separate each level's value with a greater than symbol (>).

Language (optional)

The language used for the user's account.

Status (optional)

The user's status:

Active - The user account may be used to access SmarterU.
Inactive - The user account may not be used to access SmarterU.

1 - The user can provide feedback on online course tasks.
0 - The user cannot provide feedback on online course tasks.

This tag also accepts true or false (must be in lowercase).

PhonePrimary (optional)

The user's primary phone number.

PhoneAlternate (optional)

The user's alternate phone number.

PhoneMobile (optional)

The user's mobile phone number.

Fax (optional)

The user's fax number.

Website (optional)

The user's website in its full URL format (eg. https://www.domain.com).

Address1 (optional)

The first line of the user's address.

Address 2 (optional)

The second line of the user's address.

City (optional)

The city of the user's address.

Province (optional)

The province or state of the user's address. This is the full name of the province or state.

Country (optional)

The country of the user's address:

Canada
United States
International

PostalCode (optional)

The postal code of the user's address.

SendMailTo (optional)

Indicates where the user's physical mail should be sent:

Personal - The user's physical mail should be sent to their personal address.
Organization - The user's physical mail should be sent to their organization's address.

Roles (optional)

A container for the user's learning plans.

<Roles>
   <Role>
      <RoleName><![CDATA[]]></RoleName>
         - OR -
      <RoleID><![CDATA[]]></RoleID>
      <RoleAction><![CDATA[]]></RoleAction>
   </Role>
</Roles>

Each learning plan is contained in a Role tag and contains the following.

Tag	Description
RoleName	The learning plan's name. This tag is mutually exclusive with the RoleID tag. This is the Name returned by the getRole and listRoles methods.
RoleID	The learning plan's user-specified identifier. This tag is mutually exclusive with the RoleName tag. This is the RoleID returned by the getRole and listRoles methods.
RoleAction	Indicates whether the learning plan is to be added or removed from the user: Add - Adds the learning plan to the user. Remove - Removes the learning plan from the user.

ReceiveNotifications (optional)

Indicates whether the user will receive email notifications:

True - The user will receive email notifications.
False - The user will not receive email notifications.

HomeGroup (optional)

The name of the user's home group.

The Groups tag group is container for the user's groups and group permissions.

A user must belong to at least one group, even if they are not assigned any group permissions.
The groups that a user can be added to are linked to the permissions that the calling User API key grants.

<Groups>
   <Group>
      <GroupName><![CDATA[]]></GroupName>
         - OR -
      <GroupID><![CDATA[]]></GroupID>
      <GroupAction><![CDATA[]]></GroupAction>
      <GroupPermissions>
         <Permission>
            <Action><![CDATA[]]></Action>
            <Code><![CDATA[]]></Code>
         </Permission>
         <Permission>
            <Action><![CDATA[]]></Action>
            <Code><![CDATA[]]></Code>
         </Permission>
      </GroupPermissions>
   </Group>
</Groups>

Each group is contained in a Group tag and may contain the following.

GroupName

The group's name. This tag is mutually exclusive with the GroupID tag. This is the Name returned by the getGroup and listGroups methods.

GroupID

The gruop's user-specified identifier. This tag is mutually exclusive with the GroupName tag. This is the GroupID returned by the getGroup and listGroups methods.

GroupAction

Indicates whether the group is to be added or removed from the user:

Add - Adds the group to the user, or updates their group permissions if they're already assigned to the group.
Remove - Removes the gruop from the user.

GroupPermissions

A container for the user's group permissions. Each permission is contained in a Permission tag and contains the following.

Tag	Description
Action	Indicates whether the permission is to be added or removed from user: Grant - Adds the permission to the user. Deny - Removes the permission from the user.
Code	The permissions code: Manage_Group - Grants the Group Manager permission. Create_Course - Grants the Create Course permission. Manage_Group_Courses - Grants the Manage Group Courses permission. Manage_Users - Grants the Manage Users permission. Manage_Group_Users - Grants the Manage Group Users permission. View_Learner_Results - Grants the View Learner Results permission. Proctor - Grants the Quiz Proctor permission. Marker - Grants the Long Answer Quiz Marker permission. Instructor - Grants the Instructor-Led Training Instructor permission.

Tag

Description

Action

Indicates whether the permission is to be added or removed from user:

Grant - Adds the permission to the user.
Deny - Removes the permission from the user.

Code

The permissions code:

Manage_Group - Grants the Group Manager permission.
Create_Course - Grants the Create Course permission.
Manage_Group_Courses - Grants the Manage Group Courses permission.
Manage_Users - Grants the Manage Users permission.
Manage_Group_Users - Grants the Manage Group Users permission.
View_Learner_Results - Grants the View Learner Results permission.
Proctor - Grants the Quiz Proctor permission.
Marker - Grants the Long Answer Quiz Marker permission.
Instructor - Grants the Instructor-Led Training Instructor permission.

In the following example, the user would be assigned to the Legal group and granted the Manage Users and Manage Group Users permissions. The user would also have their Group Manager permission for the Human Resources group revoked.

<Groups>
   <Group>
      <GroupName>Legal</GroupName>
      <GroupAction>Add</GroupAction>
      <GroupPermissions>
         <Permission>
            <Action>Grant</Action>
            <Code>MANAGE_USERS</Code>
         </Permission>

         <Permission>
            <Action>Grant</Action>
            <Code>MANAGE_GROUP_USERS</Code>
         </Permission>
      </GroupPermissions>
   </Group>

   <Group>
      <GroupName>Human Resources</GroupName>
      <GroupAction>Add</GroupAction>
      <GroupPermissions>
         <Permission>
            <Action>Deny</Action>
            <Code>MANAGE_GROUP</Code>
         </Permission>
      </GroupPermissions>
   </Group>

</Groups>

If no child tags are added to the GroupPermissions tag, no group permissions will be granted, but the user will be assigned to the group. In the following example, the user would be added to the Legal group, but would have no permissions on the group.

<Groups>
   <Group>
      <GroupName>Legal</GroupName>
      <GroupPermissions></GroupPermissions>
   </Group>
</Groups>

The Venues tag group is a container for the user's venues.

<Venues>
   <Venue>
      <VenueName><![CDATA[]]></VenueName>
      <Visibility><![CDATA[]]></Visibility>
      <AutoWaitingList><![CDATA[]]></AutoWaitingList>
   </Venue>
</Venues>

Each venue is contained in a Venue tag and contains the following.

VenueName

The venue's name.

Visibility

Indicates whether the venue is visible to the user by default:

1 - The venue is visible to the user by default.
0 - The venue is not visible to the user by default.

AutoWaitingList

Not yet implemented.

The Wages tag group is a container for the user's wages.

<Wages>
   <Wage>
      <WageID><![CDATA[]]></WageID>
      <WageAction><![CDATA[]]></WageAction>
      <EffectiveDate><![CDATA[]]></EffectiveDate>
      <HourlyWage><![CDATA[]]></HourlyWage>
   </Wage>
</Wages>

Only administrators, owners, and users with the Edit Wages & Training Costs account permission will be able to edit a user's wages.

Each wage is contained in a Wage tag and contains the following.

WageID

The system-generated identifier of the wage to update.

WageAction

Indicates whether the user's wage is to be added or updated:

Add - Adds the user's wage.
Update - Updates the user's wage.

EffectiveDate

The date that the user's wage took effect. Effective dates are unique for a user's wages.

HourlyWage

The wage value as a decimal.

API Response XML Package

The API response XML package will always include a Result, Info, and Errors tag.

<SmarterU>
    <Result></Result>
    <Info>
        <Email><![CDATA[]]></Email>
        <EmployeeID><![CDATA[]]></EmployeeID>
    </Info>
    <Errors>
        <Error>
            <ErrorID></ErrorID>
            <ErrorMessage></ErrorMessage>
        </Error>
    </Errors>
</SmarterU>

The response may also contain the following.

Email

The user's email address.

EmployeeID

The user's employee ID.

Example API Response XML Package

Below is an example of an API response XML package.

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Email><![CDATA[anthony.cruz@finashoes.com]]></Email>
      <EmployeeID><![CDATA[E-23094]]></EmployeeID>
   </Info>

   <Errors>
   </Errors>
</SmarterU>

Error Codes

Error Code	Message
UU:01	The email identifier provided is not valid.
UU:02	The employee ID provided is too long.
UU:03	The given name provided is not valid.
UU:04	The surname provided is not valid.
UU:05	The birth date provided is not valid.
UU:07	The password provided is not valid.
UU:08	The time zone provided is not valid.
UU:09	The value for learner notifications must be 1 or 0.
UU:10	The value for supervisor notifications must be 1 or 0.
UU:11	The option specified to send email to is not valid. Available options are Supervisor, Self, or Alternate.
UU:12	The alternate email provided is not valid.
UU:13	The supervisor email address provided is not valid.
UU:14	The organization provided is not valid.
UU:15	You must provide at least one team.
UU:16	One or more of the team groups provided is not valid.
UU:17	One or more of the teams provided is not valid.
UU:18	One or more of the team actions provided is not valid.
UU:19	A minimum of one custom fields must be provided.
UU:20	A custom field name and value must be provided for all custom fields.
UU:21	A custom field name provided is not valid.
UU:22	A custom field value provided is not valid.
UU:23	The language provided is not valid.
UU:24	The value for a user's status must be active or inactive.
UU:25	The title provided is too long.
UU:26	The division provided is too long.
UU:27	The value for allowing feedback must be 1 or 0.
UU:28	The hire date provided is not valid.
UU:29	The termination date provided is not valid.
UU:30	The primary phone number provided is not valid.
UU:31	The alternate phone number provided is not valid.
UU:32	The mobile phone number provided is not valid.
UU:33	The fax number provided is not valid.
UU:34	The web site address provided is not valid.
UU:35	The value of address 1 is too long.
UU:36	The value of address 2 is too long.
UU:37	The city provided is too long.
UU:38	The province provided is not valid.
UU:39	The country provided is not valid.
UU:40	The postal code provided is too long.
UU:41	The home group provided is not valid.
UU:42	One or more of the groups provided is not valid.
UU:43	One or more of the group names provided is not valid.
UU:44	One or more of the group actions provided is not valid. Accepted values are Add and Remove.
UU:45	One or more of the group permissions provided is not valid.
UU:46	One or more of the group permission actions provided is not valid.
UU:47	One or more of the group permission codes provided is not valid.
UU:48	The required permissions are not met to call the updateUser method.
UU:49	The email address provided is not linked to a user in your account.
UU:50	The employee ID provided is not linked to a user in your account.
UU:51	A valid supervisor user must be provided when the SendEmailTo option is set to SUPERVISOR.
UU:52	A valid email address must be provided.
UU:53	A valid alternate email address must be provided when the SendEmailTo option is set to ALTERNATE.
UU:54	One or more supervisors provided cannot be used.
UU:55	The organization provided is not valid.
UU:56	The status provided is not valid. Only ACTIVE or INACTIVE are allowed values
UU:57	The SendMailTo value provided is not valid. Only PERSONAL or ORGANIZATION are allowed values.
UU:58	The user doesn't belong to the group you're setting as home group.
UU:59	You do not have the appropriate permissions to one or more of the groups provided.
UU:60	You can't remove a user from their home group.
UU:61	User update failed.
UU:62	Account user update failed.
UU:63	Custom field update failed.
UU:64	Group assignment update failed.
UU:65	Group permission assignment update failed.
UU:66	Group removal failed.
UU:67	Home group assignment failed.
UU:68	You can't remove a user from their home group.
UU:69	The requested user cannot be updated via the API.
UU:70	One or more of the roles provided are not valid.
UU:71	The AuthenticationType value provided is not valid. Only SmarterU, External or Both are allowed values.
UU:73	One or more of the venue names provided are not valid.
UU:74	The Venue Visibility provided is not valid. Only 1 or 0 are allowed values.
UU:75	An employee must have either a valid email address or valid employee ID.
UU:76	One or more of the group IDs provided is not valid.
UU:77	One or more of the wage IDs provided is not valid.
UU:78	One or more of the wage actions provided is not valid.
UU:79	One or more of the wage effective dates provided is not valid.
UU:80	One or more of the hourly wages provided is not valid.
UU:81	Wage effective dates must be unique.
UU:82	Wage assignment failed.
UU:83	Wage update failed.
UU:84	WageID cannot be 0 when updating a wage.
UU:86	The password provided must contain at least <AccountMinPasswordLength> characters.
UU:87	The password provided must not exceed <AccountMaxPasswordLength> characters.
UU:88	The password provided must contain at least one uppercase letter, one number, and one non-alphanumeric character.

Was this article helpful?

What's Next

Time Zones

Table of contents

Description
Who Has Access
API Call XML Package
User Tag Group
Info Tag Group
Profile Tag Group
Groups Tag Group
Venues Tag Group
Wages Tag Group
API Response XML Package
Error Codes

API: updateUser

Description

Who Has Access

API Call XML Package

User Tag Group

Identifier

Info

Profile

Groups

Venues

Wages

Info Tag Group

Email (optional)

EmployeeID (optional)

GivenName (optional)

Surname (optional)

Password (optional)

TimeZone (optional)

LearnerNotifications (optional)

SupervisorNotifications (optional)

SendEmailTo (optional)

AlternateEmail

AuthenticationType (optional)

Profile Tag Group

Supervisors (optional)

Organization (optional)

Teams (optional)

CustomFields (optional)

Language (optional)

Status (optional)

Title (optional)

Division (optional)

AllowFeedback (optional)

PhonePrimary (optional)

PhoneAlternate (optional)

PhoneMobile (optional)

Fax (optional)

Website (optional)

Address1 (optional)

Address 2 (optional)

City (optional)

Province (optional)

Country (optional)

PostalCode (optional)

SendMailTo (optional)

Roles (optional)

ReceiveNotifications (optional)

HomeGroup (optional)

Groups Tag Group

GroupName

GroupID

GroupAction

GroupPermissions

Venues Tag Group

VenueName

Visibility

AutoWaitingList

Wages Tag Group

WageID

WageAction

EffectiveDate

HourlyWage

API Response XML Package

Email

EmployeeID

Example API Response XML Package

Error Codes

Related articles

What's Next