POST
/v1/definitions/{key}/rows/intakeTake in a new lead from a form or a call
The composite deal intake: finds or creates the merchant, creates the deal on it, and optionally links the lead it came from — all in ONE transaction, so a failed deal never leaves an orphan merchant behind. merchant.legalName is required; deal.productType, deal.requestedAmount and deal.name fill the new record, and leadRowId writes the relation back to the lead. Answers 201. Deals page only.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keypath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
201application/json
the action's answer
{
"data": {
"deal": {
"archived_at": "string",
"assignees": {},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"position": 1,
"source": "string"
},
"merchant": {
"archived_at": "string",
"assignees": {},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"position": 1,
"source": "string"
},
"merchantCreated": true
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired