Learnifier
  1. Users
Learnifier
  • Course Designs
    • Lists all global course design templates
      GET
  • Organization Units
    • Get Organization Unit with External Id
      GET
    • Organization Units
      GET
    • Adds an Organization Unit
      POST
    • Get Organization Unit
      GET
    • Updates an Organization Unit
      PATCH
  • Users
    • Gets a participation by external id
      GET
    • Gets a user by external id
      GET
    • Lists all users
      GET
    • Adds a user
      POST
    • User information
      GET
    • Updates user information
      PATCH
    • User profile picture
      GET
    • Returns information about the projects the user is a participant in.
      GET
  • Projects
    • Gets Organization Unit by external id
      GET
    • Organization Unit Projects
      GET
    • Create project
      POST
    • Deletes the project
      DELETE
    • Project information
      GET
    • Update project information
      PATCH
    • Project participants
      GET
    • Add participant
      POST
    • Deletes a participant
      DELETE
    • Activate participant
      POST
    • Participant login link
      POST
    • Project team members
      GET
  • Global User Groups
    • List Global User Groups.
    • List of all users in group.
  • User Groups
    • List User Groups.
    • Create a User Group.
    • Get user group
    • List of all users in group.
    • Add user group member.
    • Remove user group member.
  1. Users

Updates user information

PATCH
/users/{userid}
Users
Updates a user. All values that have a key defined in the input will be set. So if a value should not be updated omit it totally from the input, otherwise it will be unset.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'http://learnifier.com/users/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayName": "Jane Doe",
    "externalId": "string",
    "firstName": "Jane",
    "hardLock": true,
    "homeOrg": 1234,
    "lastName": "Doe",
    "locale": "en-US",
    "primaryEmail": "jane.doe@example.com"
}'
Response Response Example
200 - Example 1
{
    "code": 0,
    "field": "string",
    "message": "string"
}

Request

Path Params
userid
string 
required
The user id
Body Params application/json
displayName
string 
optional
The name shown when the user is listed
Example:
Jane Doe
externalId
string 
optional
The external id (foreign key). Must not exceed 255 characters.
firstName
string 
optional
The first (given) name of the user
Example:
Jane
hardLock
boolean 
optional
True if the user should be locked from the system
homeOrg
integer <int64>
optional
The primary organization for the user. Must match the id of an Organization Unit.
Example:
1234
lastName
<string>
optional
The last name (surname) of the user
Example:
Doe
locale
string <locale>
optional
The user's preferred language/locale setting. Affects date and number formatting.
Example:
en-US
primaryEmail
string 
optional
The primary email for the user. Used for communication from the platform.
Example:
jane.doe@example.com
Examples

Responses

🟢200Unexpected error
application/json
Body
code
integer <int32>
optional
Optional error code
field
string 
optional
The input field that the error was related to
message
string 
optional
Optional error message
🟢201User was successfully updated
🟠409A user with the same primary email already existed.
Previous
User information
Next
User profile picture
Built with