Skip to main content
POST
Request documents from the merchant

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

dealId
string
required

Deal id

Body

application/json
items
object[]
required

Documents to request. At least one.

channel
enum<string>
required

email sends through the location’s connected mailbox (409 no_email_sender if none is connected); sms texts the upload link through the CRM conversation when the contact is linked to the CRM, otherwise the link is returned unsent; link_only never sends — you deliver the link yourself.

Available options:
email,
sms,
link_only
person_id
string

Person to send to. Defaults to the deal’s primary owner, then the business’s primary contact.

message
string

Note included in the email or text.

Maximum string length: 2000
expires_in_days
number

Days until the request expires (1–90). Default 30.

Required range: 1 <= x <= 90

Response

Created

data
object
required
meta
object
required