/v1/definitions/{key}/rows/onboardOnboard a lead
Creates a lead, puts its first task on somebody and sends an intro text or email, in one call. The lead and the task are atomic; the greeting is attempted afterwards and its outcome is reported in intro rather than failing the call. Use it instead of three separate calls when taking on a new lead end to end. NEVER for a person already on a page — that makes a second lead (capability sweep, 2026-10-20: "send the application to Dmitri Salas" onboarded him again); a record that exists is sent its form with the record's form-link.
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/jsonrequiredkeyed by column name (or id); every value is TEXT — a number or true/false is taken as its text, null empties the cell, a date or a list is written as a string
Responses
the action's answer
{
"data": {
"intro": {
"conversationId": 1,
"error": "string",
"messageId": 1,
"sent": true,
"to": "string"
},
"lead": {
"archived_at": "2026-01-01T00:00:00Z",
"assignees": {},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"next_statuses": [
"string"
],
"position": 1.5,
"source": "string"
},
"task": {
"assigneeAccountId": "",
"assigneeUserId": 1,
"blockedByTaskId": 1,
"calendarEventId": "",
"cancellationReason": "string",
"cancelledAt": "2026-01-01T00:00:00Z",
"completedAt": "2026-01-01T00:00:00Z",
"completedByUserId": 1,
"createdAt": "2026-01-01T00:00:00Z",
"createdByKind": "string",
"createdByUserId": 1,
"customerActionRequired": true,
"customerVisible": true,
"description": "string",
"detail": {},
"dueAt": "2026-01-01T00:00:00Z",
"entityId": 1,
"entityKind": "string",
"escalated": true,
"escalatedAt": "2026-01-01T00:00:00Z",
"escalationCount": 1,
"id": 1,
"nodeId": "",
"outcome": "string",
"outcomeNotes": "string",
"parentTaskId": 1,
"priority": "string",
"record": "string",
"requestedDocumentType": "string",
"slaBreachAt": "2026-01-01T00:00:00Z",
"slaBreached": true,
"slaWarned": true,
"slaWarningAt": "2026-01-01T00:00:00Z",
"source": "string",
"startedAt": "2026-01-01T00:00:00Z",
"status": "string",
"tags": [
"string"
],
"taskType": "string",
"threadId": 1,
"title": "string",
"updatedAt": "2026-01-01T00:00:00Z",
"workflowExecutionId": 1
}
}
}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"
}