Max CRM API

API documentation

Use the Max CRM API to manage leads and appointments. Receive updates with webhooks or connect a lead source.

Base URLhttps://maxoutinsurance.com/api/v1
On this pageQuick startKeys and accessWebhooksCheck signaturesLead posting linkConnect a lead sourceAI tools and no-codeLimitsErrorsAPI referenceLead fieldsAllowed values

Quick start

  1. Make a key. In the CRM open Settings → Your API and choose Make a key. It starts with mxout_ and is shown once. Keep it in an environment variable, never in a web page or a repo.
  2. Check it.
    curl https://maxoutinsurance.com/api/v1/ping \
      -H "Authorization: Bearer $MAX_API_KEY"
  3. Add a lead.
    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}'
  4. Hear about changes. Add a webhook and we POST each new lead, status change, inbound text and booked appointment to your server as it happens.

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.

Keys and access

  • Send the key as Authorization: Bearer mxout_… or X-API-Key: mxout_…. A key in the address (query string) is ignored.
  • Full access keys read and write. Read only keys can make GET and HEAD requests; anything else answers 403 READ_ONLY_TOKEN.
  • Each login has one key. Making a new one, turning it off, or changing the password stops the old key at once, and the webhooks that key added, or pointed at a new address, stop with it.
  • A team manager's key works in the owner's account. Dialer seats and assistants cannot use the API.
  • 30 bad keys from one address in 10 minutes block that address for 10 minutes.

Webhooks

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.

EventWhendata
lead.createdA 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_changedA lead's status changed (for example new_lead to appointment_scheduled).The lead, plus previous_status.
lead.deletedA lead was deleted.id, status, first_name, last_name, phone and email as they were before the delete.
text.receivedSomeone 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.bookedAn 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"
  }
}

Delivery and retries

  • Any 2xx answer within 10 seconds counts as delivered. Redirects are not followed.
  • A failed try is tried again after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h, 48 h, 72 h, then given up. A retry can arrive after newer events: order by timestamp, and skip a webhook-id you already handled.
  • No success for 72 hours pauses the webhook; its events keep queueing. Turn it back on (Settings, or PATCH {"status":"active"}) and it sends what queued in the last 72 hours.
  • Answer 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.

Check signatures

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_.

Node

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);
  });
}

Python

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
    )

Connect a lead source

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 inHow fastUse it when
Lead posting linkSecondsA 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 SheetEvery 5 minutes by default; set it to every minuteA 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)SecondsZapier, Make, n8n or your own code, when you want to choose every field yourself.
CSV or Excel fileOne timeAged 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).

AI tools and no-code

  • Use our AI Assistant: 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.
  • Hand the docs to an AI: give Claude, ChatGPT or Cursor 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.
  • Brief an agent in one click: Settings → Your API → Copy instructions for an AI agent writes a prompt with your base URL, limits and the rules (errors, paging, retries). Put the key in MAX_API_KEY, not in the prompt.
  • Generate a client: load openapi.json (OpenAPI 3.1, webhooks included) into Postman, Insomnia, a code generator or a custom GPT action.
  • Zapier, Make, n8n: for a trigger, use their "Catch hook" / "Webhook" step and add its address as a webhook here. To create or update leads, use their HTTP step with your key.

Limits

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.

LimitValue
Records per request500
Records per day (UTC)10,000, leads and appointments together
Body size5 MB (64 KB on the lead posting link)
Notes per phone25
Lead posting link60 posts a minute
Webhooks per account20

Past a limit the answer is 429 with Retry-After (seconds). Retry 5xx with backoff; never resend a 4xx unchanged.

Errors

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_…" }
CodeHTTPMeaning
AUTH_REQUIRED401No token was sent. Send Authorization: Bearer <token> (or the X-API-Key header).
INVALID_TOKEN_FORMAT401The token is not in the mxout_ format. Copy it again from Settings → Your API.
INVALID_TOKEN401The token is unknown, revoked, or was replaced when a new one was generated.
TOO_MANY_AUTH_FAILURES429Too many bad tokens came from this address. Wait for Retry-After (10 minutes).
ACCOUNT_NOT_ALLOWED403This login cannot use the API: a dialer seat, an assistant, or a locked account.
READ_ONLY_TOKEN403This token was created read-only. It works for GET and HEAD requests only.
GOOGLE_CALENDAR_NOT_CONNECTED403Appointment imports need Google Calendar connected in Settings → Email & Calendar.
LEAD_NOT_FOUND404No lead with that id belongs to this account.
JOB_NOT_FOUND404No import job with that id belongs to this account.
WEBHOOK_NOT_FOUND404No webhook with that id belongs to this account.
LINK_NOT_FOUND404There is no lead posting link at that address: it was never made, was replaced by a new one, or was turned off.
INVALID_WEBHOOK_ID400The webhook id must be a positive whole number.
WEBHOOK_LIMIT_REACHED409The account already has 20 webhooks. Delete one first.
SECRET_UNAVAILABLE409The webhook's signing secret cannot be read on our side. Delete the webhook and add it again.
ACTION_NOT_FOUND404No Assistant action with that id belongs to this account.
ACTION_EXPIRED410Assistant actions can be confirmed for 30 minutes. Ask again to get a fresh one.
ACTION_ALREADY_HANDLED409This action was already confirmed or cancelled. error.status says which.
ACTION_NOT_READY422The 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_ONLY422This kind of card (file import, PDF download, admin) can only be confirmed in the CRM.
ACTION_FAILED422The CRM refused the change. error.message is the CRM's own reason (for example: no texting number, Gmail not connected).
AI_CREDITS_EXHAUSTED402The account is out of AI credits. Add funds in Settings → Billing.
PLAN_REQUIRED402The AI Assistant needs a paid plan, as it does in the CRM.
ASSISTANT_UNAVAILABLE503The Assistant is not available right now. Retry in a minute.
ROUTE_NOT_FOUND404No endpoint at that path under /api/v1. See GET /api/v1.
METHOD_NOT_ALLOWED405The path exists, but not for this HTTP method. The Allow header lists the methods that work.
BAD_REQUEST400The request could not be read.
INVALID_JSON400The body is not valid JSON.
INVALID_PAYLOAD400The body is missing the array or object the endpoint needs.
VALIDATION_FAILED400One or more fields are wrong. error.fields lists each one with what to fix (and a did-you-mean).
EMPTY_LIST400The lead posting list contains no records.
TOO_MANY_LEADS400A lead posting link accepts at most 50 leads per post.
INVALID_XML400The XML lead post could not be read.
XML_NOT_ALLOWED400XML lead posts cannot include DOCTYPE or ENTITY declarations.
EMPTY_PAYLOAD400The request contains no records.
BATCH_TOO_LARGE400More than 500 records in one request. Split the batch.
INVALID_CURSOR400The cursor is not valid for this list. Start again without a cursor.
INVALID_JOB_ID400jobId must be a positive whole number.
INVALID_LEAD_ID400The lead id must be a positive whole number.
BODY_TOO_LARGE413The body is over 5 MB. Split the batch.
DUPLICATE_PHONE409Another lead in this account already has that phone number. error.lead_id names it.
NOTE_LIMIT_REACHED409This phone already has 25 notes. The CRM keeps at most 25 per phone (phone calls are not counted).
DAILY_LIMIT_EXCEEDED429The account used its 10,000 records for today (UTC). error.resets_at says when it resets.
TOO_MANY_JOBS429Two appointment imports are already running. Poll them with GET /api/v1/jobs/{jobId}, then send the next.
RATE_LIMITED429Too many requests for this account in the last minute. error.retry_after_seconds says when to retry.
DB_STARTING503The server is starting. Retry after the Retry-After seconds.
SERVER_ERROR500Something failed on our side. request_id identifies the failure in our logs.
AUTH_ERROR500The token could not be checked. Retry. Your token is not the problem.

API reference

Also as OpenAPI 3.1 and Markdown.

Start here

GET/api/v1no key

Index: version, base URL, and every endpoint.

Answers: 200 The index.

GET/api/v1/openapi.jsonno key

OpenAPI 3.1 description of this API (for code generators and Swagger tools).

Answers: 200 OpenAPI document.

GET/api/v1/docs.mdno key

This API in one Markdown page: auth, endpoints, error codes, limits.

Answers: 200 text/markdown.

GET/api/v1/referenceno key

Allowed values: statuses, lead types, origins, webhook events, access levels, limits, error codes.

Answers: 200 Reference data.

GET/api/v1/docsno key

The developer guide and full reference as a web page (also at /developers).

Answers: 200 text/html.

GET/api/v1/llms.txtno key

A short index for AI tools (llms.txt): what this API is and where the full docs are.

Answers: 200 text/plain.

GET/api/v1/lead-sources.mdno key

Connect a lead source, step by step: GOAT Leads, any lead company with a webhook, Google Sheets, Zapier / Make, CSV.

Answers: 200 text/markdown.

GET/api/v1/lead-sourcesno key

The same lead-source guides as JSON (ways in, vendor guides, steps, a ready AI prompt).

Answers: 200 The guides.

Account

GET/api/v1/pingany key

Check 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.

GET/api/v1/meany key

The account in more detail: token access, usage today, limits, lead routing and intake flows.

Answers: 200 The account detail.

Reporting

GET/api/v1/leads/export.csvany key

Download leads as CSV (up to 50,000 rows). Read tokens allowed.

QueryTypeMeaning
sincestringISO date or time. Only leads created at or after it.
untilstringISO date or time. Only leads created at or before it.
statusstringOnly this status (see /reference).

Answers: 200 text/csv file. · 400 VALIDATION_FAILED.

GET/api/v1/activityany key

Newest-first feed of status changes, notes, calls and texts for this account's leads.

QueryTypeMeaning
sincestringISO date or time. Only events at or after it.
limitintegerPage size, 1 to 500. Default 100.
cursorstringnext_cursor from the previous page.

Answers: 200 A page of activity items.

Calls

POST/api/v1/callsfull-access key

Log 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.

Leads

GET/api/v1/leadsany key

List leads, newest first. Filter by status, source, phone, or updated_since. Page with next_cursor.

QueryTypeMeaning
statusstringOnly this status (see /reference).
sourcestringOnly this source, exact match.
phonestringOnly this phone (any format; the last 10 digits are used).
updated_sincestringISO date or time. Only leads changed at or after it.
limitintegerPage size, 1 to 100. Default 50.
cursorstringnext_cursor from the previous page.

Answers: 200 A page of leads. · 400 INVALID_CURSOR or VALIDATION_FAILED.

POST/api/v1/leadsfull-access key

Create 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.

GET/api/v1/leads/{id}any key

One lead.

PathMeaning
idLead id.

Answers: 200 The lead (read-only monthly_premium, coverage_amount, policy_number, vendor when set). · 404 LEAD_NOT_FOUND.

PATCH/api/v1/leads/{id}full-access key

Change some fields of a lead. Changing status or drip_enabled goes through the same rules the CRM uses.

PathMeaning
idLead id.

Body: Only the fields to change.

Answers: 200 The lead after the change. · 404 LEAD_NOT_FOUND. · 409 DUPLICATE_PHONE.

DELETE/api/v1/leads/{id}full-access key

Delete a lead and the data kept with it (same as Delete in the CRM). Cannot be undone.

PathMeaning
idLead id.

Answers: 200 Deleted. · 404 LEAD_NOT_FOUND.

POST/api/v1/leads/importfull-access key

Import 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.

Notes

GET/api/v1/leads/{id}/notesany key

Notes on the lead’s phone that this account wrote (newest first, up to 50).

PathMeaning
idLead id.

Answers: 200 Notes. · 404 LEAD_NOT_FOUND.

POST/api/v1/leads/{id}/notesfull-access key

Add an activity note to the lead’s phone. The CRM keeps 25 per phone.

PathMeaning
idLead id.

Body: note: text, up to 5000 characters.

Answers: 201 The note. · 409 NOTE_LIMIT_REACHED.

Appointments

GET/api/v1/appointmentsany key

List appointments, newest first. Filter by date range or lead. Page with next_cursor.

QueryTypeMeaning
fromstringFirst appointment date, YYYY-MM-DD.
tostringLast appointment date, YYYY-MM-DD.
lead_idintegerOnly this lead.
limitintegerPage size, 1 to 100. Default 50.
cursorstringnext_cursor from the previous page.

Answers: 200 A page of appointments.

POST/api/v1/appointments/importfull-access key

Book 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.

GET/api/v1/jobs/{jobId}any key

Status of a background import: queued, running, completed, partial, or failed, with per-row errors.

PathMeaning
jobIdJob id from the import response.

Answers: 200 The job. · 404 JOB_NOT_FOUND.

Webhooks

GET/api/v1/webhooksany key

The account's webhooks, newest first. Secrets are never listed.

Answers: 200 Webhooks.

POST/api/v1/webhooksfull-access key

Send 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.

GET/api/v1/webhooks/{id}any key

One webhook, with its status and last success or failure.

PathMeaning
idWebhook id.

Answers: 200 The webhook. · 404 WEBHOOK_NOT_FOUND.

PATCH/api/v1/webhooks/{id}full-access key

Change 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.

PathMeaning
idWebhook id.

Body: Only the fields to change.

Answers: 200 The webhook after the change. · 404 WEBHOOK_NOT_FOUND.

DELETE/api/v1/webhooks/{id}full-access key

Delete a webhook. Its waiting events are dropped.

PathMeaning
idWebhook id.

Answers: 200 Deleted. · 404 WEBHOOK_NOT_FOUND.

POST/api/v1/webhooks/{id}/testfull-access key

Send a signed webhook.test event now and report what your server answered.

PathMeaning
idWebhook id.

Answers: 200 ok, status_code, error, ms. · 404 WEBHOOK_NOT_FOUND.

GET/api/v1/webhooks/{id}/eventsany key

Events for this webhook in the last 30 days, newest first, with the body and how delivery went. Use it to catch up after downtime.

PathMeaning
idWebhook id.
QueryTypeMeaning
statusstringpending, delivered, failed or skipped.
sincestringISO date or time. Only events at or after it.
limitintegerPage size, 1 to 100. Default 25.
cursorstringnext_cursor from the previous page.

Answers: 200 A page of events. · 404 WEBHOOK_NOT_FOUND.

POST/api/v1/intake/{token}link is the key

Add 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.

PathMeaning
tokenThe 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.

Assistant

GET/api/v1/assistant/toolsany key

Every 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.

POST/api/v1/assistant/runfull-access key

Ask 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).

GET/api/v1/assistant/actions/{id}any key

One Assistant action: pending, not_ready, running, done, failed, cancelled or expired (30 minutes), with the card and the result.

PathMeaning
idAction id from /assistant/run.

Answers: 200 The action. · 404 ACTION_NOT_FOUND.

POST/api/v1/assistant/actions/{id}/confirmfull-access key

Do 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.

PathMeaning
idAction 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).

POST/api/v1/assistant/actions/{id}/cancelfull-access key

Drop a pending action so it can no longer be confirmed.

PathMeaning
idAction id from /assistant/run.

Answers: 200 The action, status cancelled. · 409 ACTION_ALREADY_HANDLED.

Lead fields

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).

FieldMeaning
first_name
also firstName
First name. At least one of first_name or last_name is needed on create.
last_name
also lastName
Last name.
phonePhone number, 7 to 15 digits. Stored as the last 10 digits. Must be unique within the account.
emailEmail address.
date_of_birth
also dateOfBirth, dob
Date of birth, YYYY-MM-DD.
genderGender, as the agent records it.
addressStreet address.
cityCity.
stateState, usually two letters. Left out on a new lead, it is filled from the phone's area code.
zip_code
also zipCode, zip
ZIP code.
statusPipeline status. One of the keys in GET /api/v1/reference.
sourceWhere the lead came from, free text (e.g. "Facebook Ad").
originHow the lead entered: import, api, funnel, facebook, booking, manual, sheets.
lead_type
also 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_type
also coverageType
Coverage label. Set lead_type instead unless you need a custom label.
coverage_amount
also coverageAmount
Coverage amount, a number.
monthly_premium
also monthlyPremium
Monthly premium, a number.
tobacco_use
also tobaccoUse
Tobacco use, e.g. "Yes" or "No".
health_class
also healthClass
Health class, free text.
ageAge in years, 0 to 120.
do_not_call
also doNotCall
true stops calls and the drip.
do_not_contact
also doNotContact
true sets Do Not Contact (same as status do_not_contact).
drip_enabled
also dripEnabled
true starts the AI drip for the lead; false stops it.
drip_product_focus
also dripProductFocus
Drip product. Same as lead_type; use lead_type.
notes
also note
Create only: the first note, saved as the main note. Later notes: POST /api/v1/leads/{id}/notes.

Allowed values

Statuses

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

Lead types

KeyLabel
final_expenseFinal Expense
termTerm Life
iulIUL
annuitiesAnnuity
generalLife Insurance
retirementRetirement
real_estateReal Estate
auto_insuranceAuto Insurance
customOther

Origins

api booking facebook funnel import manual sheets

The same lists, as JSON: GET /api/v1/reference.