Set the loan's back-office employees

Sets which of your back-office employees are working on this loan file.
Send employeeIds: what you send becomes the complete list. Anyone you
leave out is taken off, anyone new is added, and anyone already on the
file who is still in the list is left exactly as they are. Send an
empty list to take everyone off. This is the same body the PUT on
this path takes, and the same way subStatusIds works on
PATCH /api/v4/loans/{id}.

This replaces the deprecated PUT on the same path.

⚠️ Send the whole list every time. To add one person, send everyone
already on the file plus them — read the list first with
GET /api/v4/loans/{id}/employees. Leaving someone out takes them off.
If two people change the list at the same moment, the later request
replaces the earlier one's list.

Safe to repeat. Sending the list that is already on the file
changes nothing: no note, no email, and no error.

Every id you are adding must be an active back-office employee on
your account. If even one is not, the whole request is refused with
422 and nothing changes at all, including anyone you left out.
Someone already on the file is not checked that way, so an employee
who has since been deactivated can stay on a file they are on — this
is where the PATCH differs from the PUT, which refuses them.
Each id may appear only once; a repeated id is refused with 422.
You'll get a 404 if the loan file is not on your account, or is filed under a branch you are not assigned to.

Each change is also written onto the loan file, exactly as the PUT
does it:

  • A note for every employee added or taken off — "File assigned to
    Jane Doe (Processor)", "File removed from …" — which shows up in the
    back office under Notes History. Whether that note is private
    follows your company's setting for system notes.
  • The loan file's last-updated time moves when the request adds
    someone. Taking someone off does not move it, which matches what the
    back office does.
  • The assignment history records that the change came in through the
    API.
  • Every employee added is emailed, the same message the back office
    sends when someone is assigned. Employees taken off are not emailed.
    The mail goes out through the same background process that sends all
    LendingWise mail, so it leaves shortly after your request rather than
    during it.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The loan file you are working with, by its numeric id — the same id you use on /api/v4/loans/{id}.

Body Params
employeeIds
array of integers, unique
required

The complete list of back-office employees who should be on this loan file, by their id — the same id GET /api/v4/back-office-employees returns. Anyone left out is taken off. An empty list takes everyone off.

employeeIds*
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json