Create or update a broker

post

https://api.lendingwise.com/api/v4/brokers

Creates or updates a broker on your processing company.

A broker is matched by email address, and only among your own brokers.
If the address already belongs to one of your brokers, that broker is
updated in place. If it does not, a new broker is created for you.
Send only the fields you want to change — anything you leave out stays
as it is.

Matching stops at your own company, on purpose. One email address can
belong to brokers at several processing companies, so a broker
elsewhere with the same address is not "the same broker": that record
is never read and never changed. A loan officer of yours with that
address is left alone too, because brokers and loan officers are held
as one kind of record and this endpoint only ever writes brokers.

A broker created here shows up in GET /api/v4/brokers straight away,
and can be put on a loan file.

userName is set when the broker is first created. It is not changed
on a broker who already exists.

You get 200 on success, with the broker that was created or updated.
You get 206 when the body has no email — without it there is no way
to tell which broker you mean, so nothing is written. You get 422
when the body cannot be used, which includes trying to use the
reserved address …@dummyAgentemail.com: that address is an internal
marker meaning "no broker", not a real broker.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The broker to create or update. email is what says which broker you
mean.

The field names here are the same ones the 200 reply uses, so you
can take a reply, change a value, and send it straight back. Fields
you cannot write are accepted and ignored rather than refused, so you
do not have to strip them out first.

Some spellings are refused: send zipCode rather than zipcode,
faxNumber rather than fax, and preferredCommunication rather
than prefCommunication. Capitalised names such as PrimaryID or
ZipCode are refused as well. In each case you get a 422 naming the
field to send instead.

The body POST /api/v4/brokers accepts when creating or updating a
broker.

Field names are camelCase, and they are the same names the reply uses,
so a reply body can be sent straight back. email says which broker
you mean. Every other field is optional when updating, and anything you
leave out stays as it is.

string

required

The broker's email address. It is both how you reach the broker and how this endpoint works out which broker you mean.

userName

string

The broker's sign-in name for the broker portal. Set it when the broker should be able to sign in; leave it out to keep whatever is there already.

firstName

string

Broker's given (first) name.

lastName

string

Broker's family (last) name.

company

string

Brokerage company name on file for this contact.

address

string

Street address of the broker's office.

city

string

City portion of the broker office address.

state

string

Two-letter US state code — for example CA or NY. Compliance and reporting use it.

zipCode

string

Postal code, US format (NNNNN or NNNNN-NNNN). Send it as zipCode — zipcode is refused with a 422 naming the spelling to use.

faxNumber

string

Fax number for the brokerage. Send it as faxNumber — fax is refused with a 422 naming the spelling to use.

phoneNumber

string

🔴 This is the TOLL-FREE number, despite the name. It writes the
field the back-office screen labels "Phone Number/Toll Free".

It is NOT the broker's main contact number — that is cellNumber,
just below. GET /api/v4/brokers/{id} returns this same number
under the clearer name phoneTollFree.

Recommended format is E.164, for example +1NNNNNNNNNN.

cellNumber

string

🔴 This is the MAIN contact number, despite the name. It writes the
field the back-office screen labels plainly "Phone Number" —
some companies label it "Cell Number" — and it is checked as a
10-digit mobile number.

GET /api/v4/brokers/{id} returns this same number under the name
phone.

Recommended format is E.164, for example +1NNNNNNNNNN.

serviceProvider

string

Free-text label for the broker's wholesale service-provider relationship. It affects how loan files coming from this broker are routed.

preferredCommunication

How the broker prefers to be contacted. Send either a list, or the
comma-separated string this endpoint gives back, so a reply can be
sent straight back. A list is joined up with commas on the way in.

Send it as preferredCommunication — prefCommunication is
refused with a 422 naming the spelling to use.

Values in common use are Email, Phone, Text and Fax. Each
company sets its own, so these are listed as a guide and never
enforced.

Responses

200The broker that was created or updated on your processing company.

206The body had no email, so there was no way to tell which broker you meant. Nothing was written.

400Your request body could not be read, so nothing was changed. error.details.reason says what the problem was.

401Your bearer token is missing, or it is not valid. Get a new one from POST /api/v4/authenticate and send it again.

415Your body is JSON, but it was not labelled as JSON, so it was not read and nothing was changed. Send it again with Content-Type: application/json.

422One or more of the values you sent cannot be used, so nothing was changed. error.fields names each field and says what was wrong.

429You have made too many calls, so this one was refused and nothing was changed. Retry-After says how many seconds to wait; sending the same request again after that works.

defaultAny other failure. The shape is the same as every other error reply, so the same code can read it.