Skip to main content
POST
Create or send a merchant portal link

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

dealId
string
required

Deal id

Body

application/json
person_id
string

Person to send the link to. Defaults to the deal’s primary owner, then the business’s primary contact. Ignored when send_via is none.

send_via
enum<string>
default:none

email sends through the CRM conversation when the contact is linked to the CRM, else through the location’s connected mailbox. sms texts through the CRM conversation (contact must be linked to the CRM). none only returns the link.

Available options:
email,
sms,
none
message
string

Message to send. {{link}} is replaced with the URL; when absent the link is appended. Defaults to a short note with the link.

Maximum string length: 2000
expires_in_days
number

Accepted for forward compatibility but ignored: portal links always last 24 hours and the portal lets the merchant request a fresh one.

Required range: 1 <= x <= 30

Response

Created

data
object
required
meta
object
required