GET/api/v1no key
Index: version, base URL, and every endpoint.
Answers: 200 The index.
Use the Max CRM API to manage leads and appointments. Receive updates with webhooks or connect a lead source.
https://maxoutinsurance.com/api/v1mxout_ and is shown once. Keep it in an environment variable, never in a web page or a repo.curl https://maxoutinsurance.com/api/v1/ping \
-H "Authorization: Bearer $MAX_API_KEY"curl -X POST https://maxoutinsurance.com/api/v1/leads \
-H "Authorization: Bearer $MAX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"first_name":"Ana","last_name":"Lee","phone":"555-014-2000","lead_type":"final_expense","sms_consent":true}'Every address starts with https://maxoutinsurance.com/api/v1. Fields are snake_case (camelCase works on input too), times are ISO 8601 in UTC, lists come newest first and page with next_cursor.
Authorization: Bearer mxout_… or X-API-Key: mxout_…. A key in the address (query string) is ignored.GET and HEAD requests; anything else answers 403 READ_ONLY_TOKEN.A webhook sends events to your https address as they happen, usually within a few seconds. Add one in Settings → Your API → Webhooks, or with a full-access key:
curl -X POST https://maxoutinsurance.com/api/v1/webhooks \
-H "Authorization: Bearer $MAX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/max-webhook","events":["lead.created","lead.status_changed"]}'The answer includes the webhook's secret (it starts with whsec_), shown once; Settings can show it again. The address must be public https on the standard port. An account can have 20 webhooks.
| Event | When | data |
|---|---|---|
lead.created | A lead was added to the account, by any route: a website form, Facebook, an import, this API or by hand. | The lead, the same shape GET /api/v1/leads/{id} returns. |
lead.status_changed | A lead's status changed (for example new_lead to appointment_scheduled). | The lead, plus previous_status. |
lead.deleted | A lead was deleted. | id, status, first_name, last_name, phone and email as they were before the delete. |
text.received | Someone texted one of the account's numbers. | message_id, from, to, body, received_at, and lead_id when the number belongs to a lead. |
appointment.booked | An appointment was booked (CRM, booking page, dialer, AI drip or this API). | The appointment, the same shape GET /api/v1/appointments returns. |
Every delivery is a POST with a JSON body:
{
"id": "3f0c2a64-6b1e-4f62-9d1c-0f1a2b3c4d5e",
"type": "lead.created",
"timestamp": "2026-11-12T15:04:05.000Z",
"account_id": 12,
"data": {
"id": 4821,
"first_name": "Ana",
"last_name": "Lee",
"phone": "5550142000",
"email": "ana@example.com",
"state": "TX",
"status": "new_lead",
"source": "Acme Leads",
"origin": "api",
"lead_type": {
"key": "final_expense",
"label": "Final Expense",
"from": "set"
},
"drip_enabled": true,
"crm_url": "https://maxoutinsurance.com/crm/overview?phone=5550142000"
}
}timestamp, and skip a webhook-id you already handled.PATCH {"status":"active"}) and it sends what queued in the last 72 hours.410 Gone and the webhook is turned off.POST /api/v1/webhooks/{id}/test (or Send test in Settings) sends a signed webhook.test event right away. GET /api/v1/webhooks/{id}/events lists the last 30 days of events with their bodies, to catch up after downtime.Deliveries are signed the Standard Webhooks way, so its libraries work too. Check every delivery against the raw body, before you parse it:
webhook-id: the event id, the same on every retry.webhook-timestamp: when this try was sent, in seconds since 1970.webhook-signature: v1, then the base64 HMAC-SHA256 of <id>.<timestamp>.<raw body>, keyed with the base64-decoded part of the secret after whsec_.import crypto from 'node:crypto';
// secret: the webhook's whsec_ secret. headers: lower-cased request headers.
// body: the raw request body as text (verify before you parse it).
export function isFromMax(secret, headers, body) {
const id = headers['webhook-id'];
const timestamp = headers['webhook-timestamp'];
// Refuse anything more than five minutes old, so a copied delivery can't be replayed.
const age = Math.abs(Date.now() / 1000 - Number(timestamp));
if (!id || !(age <= 5 * 60)) return false;
const key = Buffer.from(secret.slice('whsec_'.length), 'base64');
const expected = Buffer.from(
crypto.createHmac('sha256', key).update(`${id}.${timestamp}.${body}`).digest('base64')
);
return String(headers['webhook-signature'] || '').split(' ').some((part) => {
const [version, value = ''] = part.split(',');
const given = Buffer.from(value);
return version === 'v1' && given.length === expected.length && crypto.timingSafeEqual(given, expected);
});
}import base64, hashlib, hmac, time
def is_from_max(secret: str, headers: dict, body: bytes) -> bool:
msg_id = headers.get("webhook-id", "")
timestamp = headers.get("webhook-timestamp", "0")
if not msg_id or abs(time.time() - int(timestamp)) > 300:
return False
key = base64.b64decode(secret.removeprefix("whsec_"))
signed = f"{msg_id}.{timestamp}.".encode() + body
expected = base64.b64encode(hmac.new(key, signed, hashlib.sha256).digest()).decode()
return any(
part.split(",", 1)[0] == "v1" and hmac.compare_digest(part.split(",", 1)[1], expected)
for part in headers.get("webhook-signature", "").split(" ") if "," in part
)Take leads from a website form or a lead vendor with no key and no code. Turn it on in Settings → Your API → Lead posting link and paste the address into the form or the vendor's "post leads to URL" setting. It looks like https://maxoutinsurance.com/api/v1/intake/lp_….
Anyone with the link can add leads (it can never read them), so give it only to the service that posts. New link replaces it and the old one stops at once.
curl -X POST https://maxoutinsurance.com/api/v1/intake/lp_… \
-H "Content-Type: application/json" \
-d '{"First Name":"Ana","Last Name":"Lee","Phone":"(555) 014-2000","Product":"Final Expense","Vendor":"Acme Leads","TCPA":"yes"}'Send one lead as JSON, form fields or XML. Send up to 50 leads as a JSON array, an object with a leads array, or XML with a leads root and one lead element per record. A batch returns HTTP 200 with data.results in input order. Each result has a status and either a lead_id or an error. Names are matched without case, spaces or punctuation, so First Name, first-name and FNAME are all a first name.
| We read | From fields named |
|---|---|
| First and last name | first_name, fname, last_name, lname, surname; or name / full_name, split at the last space |
| Phone (required) | phone, phone_number, mobile, cell, telephone |
email, email_address | |
| Date of birth, age | date_of_birth, dob, birthdate (YYYY-MM-DD or MM/DD/YYYY); age |
| Address | address, city, state, zip, postal_code |
| Lead type | lead_type, product, insurance_type ("Final Expense", "term", "IUL"…) |
| Coverage | coverage, coverage_amount, face_amount ("$25,000", "25k") |
| Tobacco | tobacco, smoker (yes / no) |
| Source | source, lead_source, vendor, provider |
| First note | message, comments, notes |
| Texting consent | consent, tcpa, opt_in: yes (true, yes, 1, on, or wording like "I agree to…"), no (false, no, 0, off, declined); anything else ("N/A", "unknown") saves no consent and becomes a note line; consent_text; page_url |
| Consent proof | xxTrustedFormCertUrl / trustedform_cert_url (TrustedForm: a note line, and the consent source when the post also says yes or no to consent; a certificate alone does not mark consent); leadid_token / jornaya_leadid (Jornaya: a note line) |
| Ad tracking | utm_source, utm_campaign, gclid, fbclid and the other click ids |
A vendor that can't send a source field: add ?source=Vendor%20Name to the link (60 characters at most), so leads from two vendors on one link stay apart.
Every other field goes into one note on the lead, titled "Details from" and the source. New leads follow the account's "New leads from the API" settings: drip, first messages and the consent rule.
201 {"lead_id": …}: the lead was added.200 {"lead_id": …, "duplicate": true}: the phone was already on file, so the post was added to that lead as a note.400 no phone · 404 the link was replaced or turned off · 413 over 64 KB · 429 over 60 posts a minute (wait Retry-After) or past the daily record limit.Step-by-step guides for agents, and the AI tools helping them, to get leads from a lead company into Max: https://maxoutinsurance.com/api/v1/lead-sources.md (also as JSON). In the CRM: Leads → Imports → Connect a source.
| Way in | How fast | Use it when |
|---|---|---|
| Lead posting link | Seconds | A lead company or web form that can send ("post") each new lead to a URL. Vendors call this a webhook, post URL, HTTP post, API delivery or "custom CRM". |
| Google Sheet | Every 5 minutes by default; set it to every minute | A lead company that adds each new lead as a row in a Google Sheet, or a sheet your team already fills in. |
| API key (Zapier, Make, your developer) | Seconds | Zapier, Make, n8n or your own code, when you want to choose every field yourself. |
| CSV or Excel file | One time | Aged leads, a list you bought as a download, or an old book of business. |
Vendors with a guide: GOAT Leads · Any lead company that can post to a URL · A lead company that sends to a Google Sheet · Zapier or Make · A file of leads (aged leads, an old book).
POST /api/v1/assistant/run with a plain-language ask runs the CRM's own Assistant (leads, texts, emails, quotes, bookings, settings) on your AI credits; anything that sends, books, changes or deletes comes back as an action you confirm with POST /api/v1/assistant/actions/{id}/confirm. See Assistant.https://maxoutinsurance.com/api/v1/docs.md (this whole page as Markdown) with your task. llms.txt is a short index for tools that look for one.MAX_API_KEY, not in the prompt.openapi.json (OpenAPI 3.1, webhooks included) into Postman, Insomnia, a code generator or a custom GPT action.Each verified API key has its own ceiling of 1,200 requests per minute, even when several keys use the same IP address.
Authenticated endpoints also allow 120 reads (GET and HEAD) and 60 writes (such as POST, PATCH and DELETE) per account per minute. Reads and writes have separate counters. All keys acting on the same account share those counters.
| Limit | Value |
|---|---|
| Records per request | 500 |
| Records per day (UTC) | 10,000, leads and appointments together |
| Body size | 5 MB (64 KB on the lead posting link) |
| Notes per phone | 25 |
| Lead posting link | 60 posts a minute |
| Webhooks per account | 20 |
Past a limit the answer is 429 with Retry-After (seconds). Retry 5xx with backoff; never resend a 4xx unchanged.
Every error has one shape. Branch on error.code; message is a sentence you can show a person; quote request_id when you ask us for help.
{ "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "…", "lead_id": 42 }, "request_id": "req_…" }| Code | HTTP | Meaning |
|---|---|---|
AUTH_REQUIRED | 401 | No token was sent. Send Authorization: Bearer <token> (or the X-API-Key header). |
INVALID_TOKEN_FORMAT | 401 | The token is not in the mxout_ format. Copy it again from Settings → Your API. |
INVALID_TOKEN | 401 | The token is unknown, revoked, or was replaced when a new one was generated. |
TOO_MANY_AUTH_FAILURES | 429 | Too many bad tokens came from this address. Wait for Retry-After (10 minutes). |
ACCOUNT_NOT_ALLOWED | 403 | This login cannot use the API: a dialer seat, an assistant, or a locked account. |
READ_ONLY_TOKEN | 403 | This token was created read-only. It works for GET and HEAD requests only. |
GOOGLE_CALENDAR_NOT_CONNECTED | 403 | Appointment imports need Google Calendar connected in Settings → Email & Calendar. |
LEAD_NOT_FOUND | 404 | No lead with that id belongs to this account. |
JOB_NOT_FOUND | 404 | No import job with that id belongs to this account. |
WEBHOOK_NOT_FOUND | 404 | No webhook with that id belongs to this account. |
LINK_NOT_FOUND | 404 | There is no lead posting link at that address: it was never made, was replaced by a new one, or was turned off. |
INVALID_WEBHOOK_ID | 400 | The webhook id must be a positive whole number. |
WEBHOOK_LIMIT_REACHED | 409 | The account already has 20 webhooks. Delete one first. |
SECRET_UNAVAILABLE | 409 | The webhook's signing secret cannot be read on our side. Delete the webhook and add it again. |
ACTION_NOT_FOUND | 404 | No Assistant action with that id belongs to this account. |
ACTION_EXPIRED | 410 | Assistant actions can be confirmed for 30 minutes. Ask again to get a fresh one. |
ACTION_ALREADY_HANDLED | 409 | This action was already confirmed or cancelled. error.status says which. |
ACTION_NOT_READY | 422 | The Assistant could not finish this card (for example two leads match a name). error.message says what it needs; ask again with that. |
ACTION_PANEL_ONLY | 422 | This kind of card (file import, PDF download, admin) can only be confirmed in the CRM. |
ACTION_FAILED | 422 | The CRM refused the change. error.message is the CRM's own reason (for example: no texting number, Gmail not connected). |
AI_CREDITS_EXHAUSTED | 402 | The account is out of AI credits. Add funds in Settings → Billing. |
PLAN_REQUIRED | 402 | The AI Assistant needs a paid plan, as it does in the CRM. |
ASSISTANT_UNAVAILABLE | 503 | The Assistant is not available right now. Retry in a minute. |
ROUTE_NOT_FOUND | 404 | No endpoint at that path under /api/v1. See GET /api/v1. |
METHOD_NOT_ALLOWED | 405 | The path exists, but not for this HTTP method. The Allow header lists the methods that work. |
BAD_REQUEST | 400 | The request could not be read. |
INVALID_JSON | 400 | The body is not valid JSON. |
INVALID_PAYLOAD | 400 | The body is missing the array or object the endpoint needs. |
VALIDATION_FAILED | 400 | One or more fields are wrong. error.fields lists each one with what to fix (and a did-you-mean). |
EMPTY_LIST | 400 | The lead posting list contains no records. |
TOO_MANY_LEADS | 400 | A lead posting link accepts at most 50 leads per post. |
INVALID_XML | 400 | The XML lead post could not be read. |
XML_NOT_ALLOWED | 400 | XML lead posts cannot include DOCTYPE or ENTITY declarations. |
EMPTY_PAYLOAD | 400 | The request contains no records. |
BATCH_TOO_LARGE | 400 | More than 500 records in one request. Split the batch. |
INVALID_CURSOR | 400 | The cursor is not valid for this list. Start again without a cursor. |
INVALID_JOB_ID | 400 | jobId must be a positive whole number. |
INVALID_LEAD_ID | 400 | The lead id must be a positive whole number. |
BODY_TOO_LARGE | 413 | The body is over 5 MB. Split the batch. |
DUPLICATE_PHONE | 409 | Another lead in this account already has that phone number. error.lead_id names it. |
NOTE_LIMIT_REACHED | 409 | This phone already has 25 notes. The CRM keeps at most 25 per phone (phone calls are not counted). |
DAILY_LIMIT_EXCEEDED | 429 | The account used its 10,000 records for today (UTC). error.resets_at says when it resets. |
TOO_MANY_JOBS | 429 | Two appointment imports are already running. Poll them with GET /api/v1/jobs/{jobId}, then send the next. |
RATE_LIMITED | 429 | Too many requests for this account in the last minute. error.retry_after_seconds says when to retry. |
DB_STARTING | 503 | The server is starting. Retry after the Retry-After seconds. |
SERVER_ERROR | 500 | Something failed on our side. request_id identifies the failure in our logs. |
AUTH_ERROR | 500 | The token could not be checked. Retry. Your token is not the problem. |
Also as OpenAPI 3.1 and Markdown.
/api/v1no keyIndex: version, base URL, and every endpoint.
Answers: 200 The index.
/api/v1/openapi.jsonno keyOpenAPI 3.1 description of this API (for code generators and Swagger tools).
Answers: 200 OpenAPI document.
/api/v1/docs.mdno keyThis API in one Markdown page: auth, endpoints, error codes, limits.
Answers: 200 text/markdown.
/api/v1/referenceno keyAllowed values: statuses, lead types, origins, webhook events, access levels, limits, error codes.
Answers: 200 Reference data.
/api/v1/docsno keyThe developer guide and full reference as a web page (also at /developers).
Answers: 200 text/html.
/api/v1/llms.txtno keyA short index for AI tools (llms.txt): what this API is and where the full docs are.
Answers: 200 text/plain.
/api/v1/lead-sources.mdno keyConnect a lead source, step by step: GOAT Leads, any lead company with a webhook, Google Sheets, Zapier / Make, CSV.
Answers: 200 text/markdown.
/api/v1/lead-sourcesno keyThe same lead-source guides as JSON (ways in, vendor guides, steps, a ready AI prompt).
Answers: 200 The guides.
/api/v1/pingany keyCheck the token works. Returns the account and whether Google Calendar is connected.
{
"success": true,
"data": {
"user_id": 12,
"username": "jane",
"calendar_connected": true,
"booking_slug": "jane",
"booking_path": "/book/jane"
}
}Answers: 200 The account.
/api/v1/meany keyThe account in more detail: token access, usage today, limits, lead routing and intake flows.
Answers: 200 The account detail.
/api/v1/leads/export.csvany keyDownload leads as CSV (up to 50,000 rows). Read tokens allowed.
| Query | Type | Meaning |
|---|---|---|
since | string | ISO date or time. Only leads created at or after it. |
until | string | ISO date or time. Only leads created at or before it. |
status | string | Only this status (see /reference). |
Answers: 200 text/csv file. · 400 VALIDATION_FAILED.
/api/v1/activityany keyNewest-first feed of status changes, notes, calls and texts for this account's leads.
| Query | Type | Meaning |
|---|---|---|
since | string | ISO date or time. Only events at or after it. |
limit | integer | Page size, 1 to 500. Default 100. |
cursor | string | next_cursor from the previous page. |
Answers: 200 A page of activity items.
/api/v1/callsfull-access keyLog a call from call tracking (CallRail, Google Ads, etc.). Matches or creates a lead by phone. The call also appears in that lead's call history in the CRM.
Body: phone required. Optional lead_id, attribution, create_lead_if_missing.
Answers: 201 The call row (also appears in the lead's call history in the CRM). · 200 duplicate external_id. · 404 LEAD_NOT_FOUND.
/api/v1/leadsany keyList leads, newest first. Filter by status, source, phone, or updated_since. Page with next_cursor.
| Query | Type | Meaning |
|---|---|---|
status | string | Only this status (see /reference). |
source | string | Only this source, exact match. |
phone | string | Only this phone (any format; the last 10 digits are used). |
updated_since | string | ISO date or time. Only leads changed at or after it. |
limit | integer | Page size, 1 to 100. Default 50. |
cursor | string | next_cursor from the previous page. |
Answers: 200 A page of leads. · 400 INVALID_CURSOR or VALIDATION_FAILED.
/api/v1/leadsfull-access keyCreate one lead. Same rules as an import row; a phone already on file returns 409.
Body: Lead fields. phone and a name are required.
Answers: 201 The created lead. · 409 DUPLICATE_PHONE. · 400 VALIDATION_FAILED.
/api/v1/leads/{id}any keyOne lead.
| Path | Meaning |
|---|---|
id | Lead id. |
Answers: 200 The lead (read-only monthly_premium, coverage_amount, policy_number, vendor when set). · 404 LEAD_NOT_FOUND.
/api/v1/leads/{id}full-access keyChange some fields of a lead. Changing status or drip_enabled goes through the same rules the CRM uses.
| Path | Meaning |
|---|---|
id | Lead id. |
Body: Only the fields to change.
Answers: 200 The lead after the change. · 404 LEAD_NOT_FOUND. · 409 DUPLICATE_PHONE.
/api/v1/leads/{id}full-access keyDelete a lead and the data kept with it (same as Delete in the CRM). Cannot be undone.
| Path | Meaning |
|---|---|
id | Lead id. |
Answers: 200 Deleted. · 404 LEAD_NOT_FOUND.
/api/v1/leads/importfull-access keyImport up to 500 leads in one call. Duplicates (same phone) are skipped by default and listed, not failed.
Body: leads: array of lead objects (up to 500). Optional: on_duplicate ("skip" or "create"), source, origin, dripEnabled, dripProductFocus, intakeFlowId.
Answers: 200 Counts, lead ids, skipped duplicates, and per-row errors. · 429 DAILY_LIMIT_EXCEEDED.
/api/v1/leads/{id}/notesany keyNotes on the lead’s phone that this account wrote (newest first, up to 50).
| Path | Meaning |
|---|---|
id | Lead id. |
Answers: 200 Notes. · 404 LEAD_NOT_FOUND.
/api/v1/leads/{id}/notesfull-access keyAdd an activity note to the lead’s phone. The CRM keeps 25 per phone.
| Path | Meaning |
|---|---|
id | Lead id. |
Body: note: text, up to 5000 characters.
Answers: 201 The note. · 409 NOTE_LIMIT_REACHED.
/api/v1/appointmentsany keyList appointments, newest first. Filter by date range or lead. Page with next_cursor.
| Query | Type | Meaning |
|---|---|---|
from | string | First appointment date, YYYY-MM-DD. |
to | string | Last appointment date, YYYY-MM-DD. |
lead_id | integer | Only this lead. |
limit | integer | Page size, 1 to 100. Default 50. |
cursor | string | next_cursor from the previous page. |
Answers: 200 A page of appointments.
/api/v1/appointments/importfull-access keyBook up to 500 appointments on Google Calendar. Runs in the background; poll the job.
Body: appointments: array of { firstName, date (YYYY-MM-DD), time (HH:MM), phone, email, state, notes, leadId }.
Answers: 200 The job id. Poll GET /api/v1/jobs/{jobId}. · 403 GOOGLE_CALENDAR_NOT_CONNECTED. · 429 TOO_MANY_JOBS or DAILY_LIMIT_EXCEEDED.
/api/v1/jobs/{jobId}any keyStatus of a background import: queued, running, completed, partial, or failed, with per-row errors.
| Path | Meaning |
|---|---|
jobId | Job id from the import response. |
Answers: 200 The job. · 404 JOB_NOT_FOUND.
/api/v1/webhooksany keyThe account's webhooks, newest first. Secrets are never listed.
Answers: 200 Webhooks.
/api/v1/webhooksfull-access keySend events to an https address. The answer has the signing secret (whsec_…), shown this once. A webhook made with a key stops when that key is replaced or turned off.
Body: url (public https), events (list, or "*" for all), optional description.
Answers: 201 The webhook and its secret. · 400 VALIDATION_FAILED. · 409 WEBHOOK_LIMIT_REACHED.
/api/v1/webhooks/{id}any keyOne webhook, with its status and last success or failure.
| Path | Meaning |
|---|---|
id | Webhook id. |
Answers: 200 The webhook. · 404 WEBHOOK_NOT_FOUND.
/api/v1/webhooks/{id}full-access keyChange url, events or description, or turn it off ("status": "off") and on again ("active"). Turning a paused webhook on sends what queued in the last 72 hours. A new url belongs to this key: the webhook then stops when the key is replaced or turned off.
| Path | Meaning |
|---|---|
id | Webhook id. |
Body: Only the fields to change.
Answers: 200 The webhook after the change. · 404 WEBHOOK_NOT_FOUND.
/api/v1/webhooks/{id}full-access keyDelete a webhook. Its waiting events are dropped.
| Path | Meaning |
|---|---|
id | Webhook id. |
Answers: 200 Deleted. · 404 WEBHOOK_NOT_FOUND.
/api/v1/webhooks/{id}/testfull-access keySend a signed webhook.test event now and report what your server answered.
| Path | Meaning |
|---|---|
id | Webhook id. |
Answers: 200 ok, status_code, error, ms. · 404 WEBHOOK_NOT_FOUND.
/api/v1/webhooks/{id}/eventsany keyEvents for this webhook in the last 30 days, newest first, with the body and how delivery went. Use it to catch up after downtime.
| Path | Meaning |
|---|---|
id | Webhook id. |
| Query | Type | Meaning |
|---|---|---|
status | string | pending, delivered, failed or skipped. |
since | string | ISO date or time. Only events at or after it. |
limit | integer | Page size, 1 to 100. Default 25. |
cursor | string | next_cursor from the previous page. |
Answers: 200 A page of events. · 404 WEBHOOK_NOT_FOUND.
/api/v1/intake/{token}link is the keyAdd a lead from a website form or a lead vendor with no key: the address itself is the secret. Send one lead as JSON, form fields or XML. Send up to 50 leads as a JSON array, an object with a leads array, or XML with a leads root and one lead element per record. A batch returns HTTP 200 with data.results in input order. Each result has a status and either a lead_id or an error. A phone already on file gets a note instead of a second lead.
| Path | Meaning |
|---|---|
token | The lp_… part of the link from Settings → Your API. |
Body: Any field names. A phone is required; everything we do not recognise is saved as one note.
Answers: 201 The lead was added: { lead_id }. · 200 The phone was already on file: a note was added to that lead ({ lead_id, duplicate: true }). · 400 VALIDATION_FAILED (no phone). · 404 LINK_NOT_FOUND. · 413 BODY_TOO_LARGE (over 64 KB). · 429 RATE_LIMITED (over 60 posts a minute) or DAILY_LIMIT_EXCEEDED.
/api/v1/assistant/toolsany keyEvery tool the AI Assistant can use, with its input schema and effect: reads, writes (notes, lead lists) or action (needs confirm).
Answers: 200 The tools.
/api/v1/assistant/runfull-access keyAsk the AI Assistant in plain words, the same as Run task in the CRM. Returns its reply, what it looked up, and actions (texts, emails, bookings, status changes, deletes, settings) that only happen when you confirm them. Uses AI credits like the CRM; paid plans only.
Body: message (required, up to 1500 characters); optional history (last 8 { role, content } turns) and lead_id (the lead you are talking about).
{
"success": true,
"data": {
"reply": "The text is ready. Confirm it to send.",
"actions": [
{
"id": 41,
"kind": "send_sms",
"status": "pending",
"can_confirm": true,
"sends": true,
"summary": "Text 9512845305: Hi Braven, I just emailed you the quote…"
}
],
"links": [],
"data": {}
}
}Answers: 200 reply, actions[], links[], data (leads, lead, calendar_day, appointments). · 402 AI_CREDITS_EXHAUSTED or PLAN_REQUIRED. · 503 ASSISTANT_UNAVAILABLE (nothing was changed).
/api/v1/assistant/actions/{id}any keyOne Assistant action: pending, not_ready, running, done, failed, cancelled or expired (30 minutes), with the card and the result.
| Path | Meaning |
|---|---|
id | Action id from /assistant/run. |
Answers: 200 The action. · 404 ACTION_NOT_FOUND.
/api/v1/assistant/actions/{id}/confirmfull-access keyDo the action: runs the same CRM steps as Confirm in the CRM (texts and emails really send, deletes cannot be undone). Each action runs once.
| Path | Meaning |
|---|---|
id | Action id from /assistant/run. |
Body: Optional overrides: send_sms → { message }, send_email → { subject, body }, status_change → { send_sms, send_email, sms_body }.
Answers: 200 The action, status done, with each CRM step. · 409 ACTION_ALREADY_HANDLED. · 410 ACTION_EXPIRED. · 422 ACTION_NOT_READY, ACTION_PANEL_ONLY or ACTION_FAILED (the CRM's own reason).
/api/v1/assistant/actions/{id}/cancelfull-access keyDrop a pending action so it can no longer be confirmed.
| Path | Meaning |
|---|---|
id | Action id from /assistant/run. |
Answers: 200 The action, status cancelled. · 409 ACTION_ALREADY_HANDLED.
Create and change take these. camelCase spellings work too. Unknown fields are refused with a did-you-mean (the lead posting link is the forgiving one).
| Field | Meaning |
|---|---|
first_namealso firstName | First name. At least one of first_name or last_name is needed on create. |
last_namealso lastName | Last name. |
phone | Phone number, 7 to 15 digits. Stored as the last 10 digits. Must be unique within the account. |
email | Email address. |
date_of_birthalso dateOfBirth, dob | Date of birth, YYYY-MM-DD. |
gender | Gender, as the agent records it. |
address | Street address. |
city | City. |
state | State, usually two letters. Left out on a new lead, it is filled from the phone's area code. |
zip_codealso zipCode, zip | ZIP code. |
status | Pipeline status. One of the keys in GET /api/v1/reference. |
source | Where the lead came from, free text (e.g. "Facebook Ad"). |
origin | How the lead entered: import, api, funnel, facebook, booking, manual, sheets. |
lead_typealso leadType | What kind of lead: final_expense, term, iul, annuities, general, retirement, real_estate, auto_insurance, custom. Sets the drip product and the coverage label together. |
coverage_typealso coverageType | Coverage label. Set lead_type instead unless you need a custom label. |
coverage_amountalso coverageAmount | Coverage amount, a number. |
monthly_premiumalso monthlyPremium | Monthly premium, a number. |
tobacco_usealso tobaccoUse | Tobacco use, e.g. "Yes" or "No". |
health_classalso healthClass | Health class, free text. |
age | Age in years, 0 to 120. |
do_not_callalso doNotCall | true stops calls and the drip. |
do_not_contactalso doNotContact | true sets Do Not Contact (same as status do_not_contact). |
drip_enabledalso dripEnabled | true starts the AI drip for the lead; false stops it. |
drip_product_focusalso dripProductFocus | Drip product. Same as lead_type; use lead_type. |
notesalso note | Create only: the first note, saved as the main note. Later notes: POST /api/v1/leads/{id}/notes. |
no_status new_lead called no_answer left_vm callback interested not_interested appointment_scheduled no_show follow_up application_submitted approved issued_paid declined not_taken completed do_not_contact
| Key | Label |
|---|---|
final_expense | Final Expense |
term | Term Life |
iul | IUL |
annuities | Annuity |
general | Life Insurance |
retirement | Retirement |
real_estate | Real Estate |
auto_insurance | Auto Insurance |
custom | Other |
api booking facebook funnel import manual sheets
The same lists, as JSON: GET /api/v1/reference.