Download Postman Collection
API Reference

V3 Update Internal User

patch https://api.elliemae.com/encompass/v3/users/

Update an Encompass internal user. Also, use this call to disable an Encompass user account

This API endpoint added with the 24.2 release of Encompass.

Usage Notes

  • Access Rights
    • Only administrators (admin account, Super Administrator persona, and/or Administrator persona) or non-admin users with the Settings “Organizations/User” persona can update user accounts.
    • The calling user only has access to update users within their same organization, or lower child organizations of their organization.
  • PATCH call will update existing attributes with the values provided in the request body.
  • To remove a string value, use ‘null’.
  • Personas
    • For the Personas array, the PATCH call acts as a replacement operation. It will replace the entire collection of personas with the values provided in the request.
      Example: User has persona “1”, and a PATCH call is made providing personas “2” and “3”. Persona “1” will be replaced with “2” and “3”.
    • If you want to add personas to a user, you must send the current persona(s) and also the personas you are adding. Example: User has persona “1” and you want to add “2” and “3”. You should send “1”, “2”, and “3” in the request.
    • If you do not know what personas the user currently has, perform GET /v3/users/{userId} call to retrieve the current personas.
    • At least one persona is required. If you attempt to remove the personas, you will receive an error.
  • Licenses collection
    • The licenses collection is a fix list of all 50 states, plus territories. It is not possible to remove a state license from the list.
    • To activate a state license, set ‘selected’ attribute to ‘true’. To deactivate a state, set ‘selected’ to false.
  • Compensation Plans
Language
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use