Create a task

Creates a task, attached to one of your loan files or general (no
loanId), and assigns it to at least one person.

Times. Send dueAt and reminderAt with an offset
(2026-11-04T17:00:00-05:00) to say exactly when you mean. Without one
they are read in your company's time zone. Leave reminderAt out for
no reminder.

What else happens. On a loan task, a note "

Who created it. Send createdBy to credit one of your back-office
employees. Leave it out and the task is credited to whoever created
your API key, as long as they still work for your company; otherwise
no one is credited.

Safe to retry. Send an Idempotency-Key and a retry after a lost
response returns the task the first call created, instead of making a
second task and emailing everyone again.

Credentials limited to some branches must attach the task to a loan
file in one of those branches. A general task needs a company-wide
credential, such as a company API key (422 on loanId otherwise).

409 means the loan file is archived: tasks cannot be added to it.
422 names every field, and every id, that was wrong, in one reply.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 250
date-time
required

When the task is due. Without an offset it is read in your company's time zone.

date-time | null

When to remind the assignees. Leave it out for no reminder.

string
enum
Defaults to Not Started

A task's status, exactly as LendingWise stores and shows it.

Allowed:
enum

Leave it out, or send null, for no priority.

string | null

Longer notes, as plain text. Line breaks are kept.

integer | null
≥ 1

The loan file to attach the task to. Leave it out for a general task.

boolean
Defaults to false

Also send the reminder as a text message. Needs reminderAt.

boolean
Defaults to false

Email every assignee now, as the task is created.

assignees
object
required

Who the task is assigned to, by kind. At least one id in total. A broker id sent as a loan officer, or the reverse, is refused.

createdBy
object

The back-office employee to credit as the task's creator.

boolean
enum

Accepted only as false. Tasks created through the API are never automation tasks.

Allowed:
Headers
string
length ≤ 64

A key you generate — a UUID is the usual choice — that makes it safe to
retry this request after a timeout.

The problem it solves. If a call times out you cannot tell whether
it landed. Retrying without a key creates a SECOND record. Retrying with
the same key returns the original result instead, and creates nothing.

  • Same key, same body → the original result, plus Idempotency-Replayed: true.
  • Same key, different body → 409. That means a bug in your code, not
    a safe retry, so the request is refused rather than guessed at.
  • No key → exactly the behaviour this endpoint has always had. The header
    is optional and nothing changes for callers that omit it.

A replay reflects the record's CURRENT state, not a byte-for-byte
copy of the original reply. If something else changed the record between
your first call and your retry, you see the change. We do this rather
than caching response bodies, because these replies carry borrower
personal data and we will not keep a copy of it at rest to serve a retry.

For the same reason a replay does not repeat meta.automation — the
automation ran once, on the original call, and saying otherwise would be
a lie about what just happened.

Keys are scoped to your own account and kept for 24 hours. After
that the key is forgotten and reusing it creates a new record, so retry
within a day. A key is at most 64 characters.

Responses

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