/v1/definitions/{key}/rows/{rowId}/form-linkMint a form link for a record
Text or email one record its application form and file the thread under that record. Name a formId (one of the workspace's own published forms) or paste a url, never both. Add prefill:true — formId only — to send the form already filled in from this record and bound to it, so what the merchant sends merges back into the same row instead of opening a second one. Medium is sms or email; the recipient is read off the record when none is given. Reach for it when a desk wants a merchant to complete an application.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"conversationId": 1,
"medium": "string",
"messageId": 1,
"prefilled": true,
"recipient": "string",
"url": "string"
}
}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"
}