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 422 when the body cannot be used, and nothing is written.
That includes a body with no email — without it there is no way to
tell which broker you mean, and the error names email — and trying
to use the reserved address …@dummyAgentemail.com: that address is
an internal marker meaning "no broker", not a real broker. (Until
API 4.1 a missing email answered 206 with a message and no
error; it is a 422 now, like every other body this route cannot
act on.)
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

