Skip to main content
PATCH
Update an offer

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

id
string
required

Offer id

Body

application/json
amount
number

Funded amount offered, USD.

Required range: x >= 1
term
number

Term length in term_unit.

Required range: x >= 1
term_unit
enum<string>

Unit of term.

Available options:
days,
weeks,
months
factor_rate
number

Factor rate, e.g. 1.35.

Required range: 1 <= x <= 3
buy_rate
number

Buy rate.

Required range: 1 <= x <= 3
payment_amount
number

Amount per payment.

Required range: x >= 0
payment_frequency
enum<string>

Payment cadence.

Available options:
daily,
weekly,
bi-weekly,
monthly
payback_amount
number

Total payback.

Required range: x >= 0
position
number

Position the advance would take.

Required range: x >= 1
points
number

Commission points (percentage of the funded amount).

Required range: 0 <= x <= 100
notes
string

Free-text notes.

Maximum string length: 5000
expires_at
string

When the offer expires (ISO 8601).

status
string

New status slug (e.g. waiting_on_stips, sold, contracts_requested, contracts_out, contracts_signed, merchant_declined). Deal-only statuses (new, submitted, declined, approved) are rejected. On the primary offer, contracts_requested/contracts_out/contracts_signed move the deal stage per the location’s event bindings. Use POST /deals/{id}/stage with mark_funded to fund; funded is not accepted here.

Maximum string length: 100
decline_reason
string

Decline reason slug, for statuses that prompt for one.

Maximum string length: 100
decline_reason_details
string

Extra decline details.

Maximum string length: 2000
failure_reason
string

Failure reason slug, for statuses that prompt for one (e.g. funding_failed).

Maximum string length: 100
failure_reason_details
string

Extra failure details.

Maximum string length: 2000

Response

OK

data
object
required
meta
object
required