Skip to main content
PATCH
Update a deal

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

id
string
required

Deal id

Body

application/json
requested_amount
number

Requested funding amount in dollars.

Required range: x >= 0
use_of_funds
string
Maximum string length: 2000
annual_revenue
number

Stated annual revenue in dollars.

Required range: x >= 0
product_type
enum<string>
Available options:
mca,
term_loan,
loc,
equipment,
factoring,
reverse_consolidation
desired_term_months
number
Required range: 1 <= x <= 120
desired_frequency
enum<string>
Available options:
daily,
weekly,
bi-weekly,
monthly
paper_grade
string

Paper grade override (A–D); marks paper_grade_source as manual.

Maximum string length: 10
originator_id
string

Originator (user id, from GET /v1/users).

originator_email
string

Originator by email, instead of originator_id. Must be an active team member.

closer_id
string

Closer (user id, from GET /v1/users).

closer_email
string

Closer by email, instead of closer_id. Must be an active team member.

lead_source
string
Maximum string length: 100
state_incorporated
string
Maximum string length: 50
risk_flags
object

Replaces the whole risk_flags object.

form_data
object

JSON merge-patch (RFC 7396) onto the deal’s form_data: nested objects merge key by key, a null value deletes the key, arrays and scalars replace.

business_name
string

Legal business name on this deal. When the deal showed its business’s legal name, the business is renamed too, and its other deals that showed the old name follow. A name the merchant typed differently changes on this deal only.

Maximum string length: 255
dba
string

DBA on this deal. When the deal showed its business’s DBA (or the business has none), the business takes it too, and its other deals that showed the old DBA follow. Otherwise it changes on this deal only.

Maximum string length: 255
industry
string
Maximum string length: 100
entity_type
string
Maximum string length: 50
business_address
string
business_city
string
Maximum string length: 100
business_state
string
Maximum string length: 50
business_zip
string
Maximum string length: 20
business_phone
string
Maximum string length: 50
business_start_date
string

YYYY-MM-DD.

Response

OK

data
object
required
meta
object
required