Skip to main content
POST
Submit a deal to lenders

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

dealId
string
required

Deal id

Body

application/json
lender_ids
string[]
required

Lenders to submit to (1–50). Lenders that already have a submission on this deal are returned unchanged and listed in meta.already_submitted.

document_ids
string[]

Documents on this deal to attach to the email. Defaults to none.

template_id
string

Email template to use. Defaults to the location’s default submission template.

message_override
string

Replaces the template body (HTML or plain text). Template variables such as {{business_name}} and {{offer_submission_link}} are still rendered.

Maximum string length: 50000
subject_override
string

Replaces the template subject.

Maximum string length: 500
send
boolean
default:true

true (default) queues one email per lender through the location’s connected mailbox. false only records the submissions as pending for the team to send from the app.

Response

One submission per lender; meta carries created, already_submitted, sending, not_sent, warning.

data
object[]
required
meta
object
required