# High Sierra Systems API > Run a sub-account from code or an AI assistant: leads, deal value and won/lost, pipeline stages, bookings and calendars, texts and emails, the inbox, calls, forms, automations and settings, over one REST API and one MCP server. ## Quick start Base URL: https://api.highsierrasystems.com (every path below starts with /v1) Auth: `Authorization: Bearer zu-...` (an admin of the sub-account creates a key in Settings → API). Envelope: every response is `{ "success": boolean, "data": object|null, "error": string|null }`. Sub-account: a key works inside its own sub-account only, so `workspace_id` can be left out. Setting the sub-account up: call GET /v1/setup-status first. It lists what is missing and names the endpoint (and MCP tool) that fixes each finding. ```bash curl "https://api.highsierrasystems.com/v1/leads?limit=5" -H "Authorization: Bearer $API_KEY" curl -X PATCH "https://api.highsierrasystems.com/v1/leads/LEAD_ID" -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \ -d '{"status":"won","deal_value_cents":250000}' ``` ## Conventions ### Authentication Send your key as `Authorization: Bearer zu-...`. Admins of a sub-account create keys in the CRM under Settings → API. A key works inside its own sub-account only: you can leave out `workspace_id` everywhere, a different one is ignored, and records of any other sub-account answer 404. Access levels: Read only, Read and write, or Full access (deleting things, team members and anything that sends lead data outside the account). Every call also follows the role of the person who made the key: a key keeps working only while they are an admin of the sub-account. ### Idempotency Every write (POST, PUT, PATCH, DELETE) accepts `Idempotency-Key: `. Replaying the same key with the same body within 24 hours returns the original response instead of doing the work twice (no second message, no second booking); the same key with a different body answers 409. Use a fresh key per logical operation, not per retry. ### Rate limits Every response carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`. On 429 a `Retry-After` header (and `retry_after_seconds` in the body) tells you how long to wait. The limit is per key, per minute: 120 by default, adjustable from 1 to 600 in Settings → API. ### Pagination List endpoints accept `limit` (default 50, max 200) and return the newest rows first. GET /v1/messages is the one endpoint with a cursor: pass `cursor` (or `since`) and follow `next_cursor` to walk forward without duplicates. ### Messaging safety limits To protect number reputation, each sub-account can message at most 300 unique contacts per UTC day (plus per-minute burst and daily segment caps). Replying to a contact you already messaged that day does not consume another contact slot. Messaging endpoints return X-Contacts-Limit, X-Contacts-Used, X-Contacts-Remaining and X-Contacts-Reset; over the cap sends answer 429 with `code: "sms_limit"` and a `limit` object. Check the current state any time with GET /v1/messages/limits. Need a higher ceiling? Request a limit increase from Settings → Messaging and we'll review it. ### Responses and errors Success is `{ success: true, data, error: null }`. Errors are `{ success: false, data: null, error: string, details?: object }` with a matching HTTP status; scope, rate-limit and budget errors put a machine-readable code in `error` (`scope_denied`, `rate_limit_exceeded`, `credit_limit_exceeded`) and the explanation in `message`. Branch on the status and the code, not on message text. ## Endpoints ### CRM leads - `GET /v1/leads` — List and filter leads (scope leads:read) Newest first. Filter by tags (`tag_match=any` returns leads with at least one of the tags, `all` leads with every one), status, pipeline stage, assignee, State, leads or existing customers (`existing_customer`; both by default), a name / email / phone search and a created-since time. Each lead carries `existing_customer`, `inquiry` (the CRM's Inquiry column), `address`, `city`, `state`, `zip`, `custom_fields`, `tags` and `stage` (the pipeline stage it shows in). Page with `limit` and `offset`: `next_offset` is set while there are more. - query `tags` (string): Tag names, comma-separated (tags=VIP,Roof), or a JSON array (tags=["Roof, metal","VIP"]) when a name has a comma. Max 10. - query `tag_match` (string): any (default): at least one of the tags. all: every tag. - query `status` (string): One or more statuses, comma-separated: new, contacted, qualified, booked, won, lost, spam, partial. - query `stage_key` (string): Pipeline stage key from GET /v1/stages. - query `assigned_to` (string): A user id (GET /v1/members): leads assigned to them. "me": the key's own user. "unassigned": nobody's. - query `state` (string): State / province / region as saved on the lead, comma-separated (state=TX,FL), like Leads > Filter > State. A name finds its code too ("Texas" finds TX). "none": leads with no State. Max 20. - query `existing_customer` (boolean): true: only existing customers (the Leads page's Existing customers view). false: only leads. Leave out for both. - query `search` (string): Matches name, email or phone (any format). - query `since` (string): ISO timestamp: only leads created at or after it. - query `limit` (number): Default 50, max 200. - query `offset` (number): Skip this many leads; pass next_offset from the previous page. - `GET /v1/leads/{lead_id}` — Get one lead (scope leads:read) The lead with every column, its raw_payload, the flattened `inquiry`, `address`, `city`, `state`, `zip`, `custom_fields`, `tags` and `stage`, plus its 50 most recent timeline events. - path `lead_id` (string, required): Lead id. - `POST /v1/leads` — Create a lead (scope leads:write) Needs workspace_id plus at least one of full_name, email or phone. Besides the lead's columns you can set `inquiry`, `address`, `city`, `state`, `zip`, `custom_fields` and `tags`. The lead and its tags are saved together, so automations that filter on tags see them; each tag fires the lead.tag_added automation trigger. A lead with the same phone (last 10 digits) or email already in the sub-account answers 409 with its `lead_id` and `matched_on` in `details`: update that lead instead. A field the API does not know answers 400 (it is never silently dropped). By default the intake doesn't run (no first text or AI opener, follow-ups, team alert or Instant Lead Connect); `run_intake: true` works it like any new lead from a form and `intake` in the response says what ran. Either way it is a new lead to the rest of the CRM, as one added by hand is: automations that start on a new lead or a tag run, AI calling campaigns that take new leads pick it up, and the lead.created webhook fires. Not with `existing_customer: true`: a past customer is no new lead, so none of that runs, it stays out of the pipeline and the lead numbers, and `run_intake` is refused (400). Returns the lead as GET /v1/leads/{lead_id} shows it. - body `full_name` (string): Lead name. - body `email` (string): Email address. - body `phone` (string): 10-digit US number or + and a country code; stored as E.164. - body `source` (string): Where the lead came from. Defaults to api. - body `status` (string): Base lead status. To move a lead in the pipeline, send stage_key instead. - body `stage_key` (string): Pipeline stage key from GET /v1/stages. A stage also sets the status it stands for. - body `existing_customer` (boolean): true = someone who was already a customer (a past customer list), not a lead, like Leads > Import "Existing customers": out of the pipeline and every lead count, and adding them starts no new-lead automations, AI calls or webhooks. A new one is won with no sale date (so no sale is counted) unless you send status or stage_key. false moves them back to leads. Changing it never moves the stage. - body `score` (number): A number 0-100 that is yours to set, e.g. a counter your automations keep. Nothing writes it for you (AI lead scoring is off). - body `notes` (string): Internal notes. - body `assigned_to` (string): User id of someone in the sub-account (GET /v1/members). The agency owner only with the owner's own key (the app never offers them to the sub-account's people; a lead already on them may stay). null unassigns. A change is logged on the lead's timeline (Lead assigned / Lead unassigned), as in the app. - body `ad_name` (string): Ad the lead came from. - body `campaign_name` (string): Campaign the lead came from. - body `utm_source` (string): UTM source. - body `utm_medium` (string): UTM medium. - body `utm_campaign` (string): UTM campaign. - body `utm_term` (string): UTM term. - body `utm_content` (string): UTM content. - body `landing_url` (string): Page the lead converted on. - body `referrer_url` (string): Referring page. - body `attribution_channel` (string): e.g. meta, google, organic, direct. - body `gclid` (string): Google Ads click id. A lead with one is sent back to the sub-account's Google Ads by its click when it books or is won (CRM conversions). - body `gbraid` (string): Google Ads app-to-web click id. - body `wbraid` (string): Google Ads web-to-app click id. - body `fbclid` (string): Facebook click id. - body `msclkid` (string): Microsoft Ads click id. - body `deal_value_cents` (number): Deal value in cents: on a won job, what the customer paid (the Sales report's Sold, and the revenue sent to Meta). - body `deal_currency` (string): 3-letter currency code. Default USD. - body `deal_parts_cents` (number): Won job: what the parts cost, in cents (Sales report). - body `deal_tip_cents` (number): Won job: the tip the technician got, in cents. - body `deal_sold_by` (string): Won job: the user id of the technician credited with the sale (GET /v1/members). null = whoever the lead is assigned to. - body `deal_won_at` (string): When the job was won (ISO 8601). Set for you when status becomes won; send it to date a sale yourself. - body `deal_type` (string): Plans & memberships: what the customer bought, one_time (a job) or plan (a plan or membership that pays again). null = one-time. A deal_plan_cents sent alone makes it a plan; one_time clears the plan. - body `deal_plan_cents` (number): Plan: its price in cents, charged every deal_plan_interval. deal_value_cents is the first payment (the plan price when you leave it out). - body `deal_plan_interval` (string): Plan: how often it's charged. Default month. - body `deal_plan_start_date` (string): Plan: when it starts (YYYY-MM-DD). Default today. - body `deal_plan_months` (number): Plan: how many months it runs (1-600). null = no end date: the business's default length counts (12 months unless changed in Settings > Features). Leads return deal_monthly_cents and deal_expected_total_cents (first payment + the plan price for the rest of its length). - body `inquiry` (string): What the lead asked about: the Inquiry column in the CRM (max 500). Without it the CRM shows the form or ad offer, then General inquiry. - body `address` (string): Street address. - body `city` (string): City. - body `state` (string): State or region. A US state, Canadian province or Australian state is stored as its code ("Texas" -> "TX"), a Mexican state by name, like every other intake; the list follows the lead's country (its phone number, else the sub-account's country). Anything else is kept as sent. - body `zip` (string): ZIP or postal code. - body `custom_fields` (object): Custom field values keyed by field_key (GET /v1/custom-fields); a field's label also works. Values are checked against the field type: number/money/rating numbers, boolean true/false, date YYYY-MM-DD, datetime ISO 8601, select one of its options, multiselect a list of options. null or "" clears a value; fields you leave out keep their value. - body `tags` (array): Tag names. New names are created in the sub-account (matched ignoring case). Max 50. - body `run_intake` (boolean): Default false. true = work the lead like a new lead from a form: first text or AI opener, follow-ups, team alert, Instant Lead Connect. - example body: {"workspace_id":"uuid","full_name":"Jane Doe","phone":"+14155550123","email":"jane@example.com","inquiry":"Roof replacement quote","address":"12 Main St","city":"Pittsburgh","state":"PA","zip":"15213","custom_fields":{"roof_type":"Metal","roof_age_years":18},"tags":["Spring promo","VIP"],"run_intake":true} - `PATCH /v1/leads/{lead_id}` — Update a lead (scope leads:write) Send only what changes; null or "" clears a value. `custom_fields` merges: values you leave out are kept. `tags` REPLACES all of the lead's tags; `add_tags` and `remove_tags` change only those (applied in that order: tags, add_tags, remove_tags). A body with only tag changes is fine. `stage_key` moves the lead in the pipeline and sets the status that stage stands for. A field the API does not know answers 400. Returns the updated lead. - path `lead_id` (string, required): Lead id. - body `full_name` (string): Lead name. - body `email` (string): Email address. - body `phone` (string): 10-digit US number or + and a country code; stored as E.164. - body `source` (string): Where the lead came from. Defaults to api. - body `status` (string): Base lead status. To move a lead in the pipeline, send stage_key instead. - body `stage_key` (string): Pipeline stage key from GET /v1/stages. A stage also sets the status it stands for. - body `existing_customer` (boolean): true = someone who was already a customer (a past customer list), not a lead, like Leads > Import "Existing customers": out of the pipeline and every lead count, and adding them starts no new-lead automations, AI calls or webhooks. A new one is won with no sale date (so no sale is counted) unless you send status or stage_key. false moves them back to leads. Changing it never moves the stage. - body `score` (number): A number 0-100 that is yours to set, e.g. a counter your automations keep. Nothing writes it for you (AI lead scoring is off). - body `notes` (string): Internal notes. - body `assigned_to` (string): User id of someone in the sub-account (GET /v1/members). The agency owner only with the owner's own key (the app never offers them to the sub-account's people; a lead already on them may stay). null unassigns. A change is logged on the lead's timeline (Lead assigned / Lead unassigned), as in the app. - body `ad_name` (string): Ad the lead came from. - body `campaign_name` (string): Campaign the lead came from. - body `utm_source` (string): UTM source. - body `utm_medium` (string): UTM medium. - body `utm_campaign` (string): UTM campaign. - body `utm_term` (string): UTM term. - body `utm_content` (string): UTM content. - body `landing_url` (string): Page the lead converted on. - body `referrer_url` (string): Referring page. - body `attribution_channel` (string): e.g. meta, google, organic, direct. - body `gclid` (string): Google Ads click id. A lead with one is sent back to the sub-account's Google Ads by its click when it books or is won (CRM conversions). - body `gbraid` (string): Google Ads app-to-web click id. - body `wbraid` (string): Google Ads web-to-app click id. - body `fbclid` (string): Facebook click id. - body `msclkid` (string): Microsoft Ads click id. - body `deal_value_cents` (number): Deal value in cents: on a won job, what the customer paid (the Sales report's Sold, and the revenue sent to Meta). - body `deal_currency` (string): 3-letter currency code. Default USD. - body `deal_parts_cents` (number): Won job: what the parts cost, in cents (Sales report). - body `deal_tip_cents` (number): Won job: the tip the technician got, in cents. - body `deal_sold_by` (string): Won job: the user id of the technician credited with the sale (GET /v1/members). null = whoever the lead is assigned to. - body `deal_won_at` (string): When the job was won (ISO 8601). Set for you when status becomes won; send it to date a sale yourself. - body `deal_type` (string): Plans & memberships: what the customer bought, one_time (a job) or plan (a plan or membership that pays again). null = one-time. A deal_plan_cents sent alone makes it a plan; one_time clears the plan. - body `deal_plan_cents` (number): Plan: its price in cents, charged every deal_plan_interval. deal_value_cents is the first payment (the plan price when you leave it out). - body `deal_plan_interval` (string): Plan: how often it's charged. Default month. - body `deal_plan_start_date` (string): Plan: when it starts (YYYY-MM-DD). Default today. - body `deal_plan_months` (number): Plan: how many months it runs (1-600). null = no end date: the business's default length counts (12 months unless changed in Settings > Features). Leads return deal_monthly_cents and deal_expected_total_cents (first payment + the plan price for the rest of its length). - body `inquiry` (string): What the lead asked about: the Inquiry column in the CRM (max 500). Without it the CRM shows the form or ad offer, then General inquiry. - body `address` (string): Street address. - body `city` (string): City. - body `state` (string): State or region. A US state, Canadian province or Australian state is stored as its code ("Texas" -> "TX"), a Mexican state by name, like every other intake; the list follows the lead's country (its phone number, else the sub-account's country). Anything else is kept as sent. - body `zip` (string): ZIP or postal code. - body `custom_fields` (object): Custom field values keyed by field_key (GET /v1/custom-fields); a field's label also works. Values are checked against the field type: number/money/rating numbers, boolean true/false, date YYYY-MM-DD, datetime ISO 8601, select one of its options, multiselect a list of options. null or "" clears a value; fields you leave out keep their value. - body `tags` (array): REPLACES all of the lead's tags ([] removes them all). To change only some, use add_tags / remove_tags. - body `add_tags` (array): Tag names to add; the lead's other tags stay. New names are created. - body `remove_tags` (array): Tag names to remove. - example body: {"add_tags":["Hot lead"],"remove_tags":["Cold"],"stage_key":"quote_sent","custom_fields":{"roof_type":"Tile"}} - `DELETE /v1/leads/{lead_id}` — Delete a lead (scope leads:admin) With delete_appointments=true its appointments go first, each the way the calendar deletes one: the synced Google / Outlook event, the customer's invite (cancelled if it was still on), its reminder texts, then the appointment; if one can't be deleted the lead is kept and the answer says how many went. Without it the appointments stay on the calendar with no lead, as before. - path `lead_id` (string, required): Lead id. - query `delete_appointments` (boolean): Also delete the lead's appointments (the app's "Also delete their appointments"). - `GET /v1/leads/{lead_id}/timeline` — Lead activity timeline (scope leads:read) - path `lead_id` (string, required): Lead id. - query `limit` (number): Default 50. - `POST /v1/leads/{lead_id}/notes` — Add a note to a lead (scope leads:write) mentions tags teammates like @Name in the app's note box: each one on the sub-account's team who can see the lead gets an email and a push with the note and a link to the conversation (replies go to you); the answer lists who was told and who was skipped and why (not_on_team, cant_see_lead). - path `lead_id` (string, required): Lead id. - body `body` (string, required): Note text. - body `actor_label` (string): Who the note is from. - body `mentions` (array): Up to 20 user ids to tag (GET /v1/members). - example body: {"body":"@Sam can you call her back after 5?","mentions":["uuid"]} - `POST /v1/leads/{lead_id}/stage` — Move a lead to a pipeline stage (scope leads:write) PATCH on the same path does the same. - path `lead_id` (string, required): Lead id. - body `stage_key` (string, required): Stage key from GET /v1/stages. - example body: {"stage_key":"booked"} - `GET /v1/stages` — List pipeline stages (scope leads:read) - `GET /v1/tags` — List lead tags (scope leads:read) Every tag in the sub-account and how many leads carry it. A tag is created automatically the first time you send its name in a lead's tags or add_tags. - `PATCH /v1/tags/{tag_id}` — Rename or recolor a tag (scope leads:write) Settings > Tags. A new name (60 characters, no commas, not another tag's name: merge them instead) and/or a color. A rename also rewrites every automation that names the tag (Add / Remove tag steps, the Tag added trigger, tag conditions) unless update_automations is false. Owners and admins. - path `tag_id` (string, required): The tag (GET /v1/tags). - body `name` (string): The new name. - body `color` (string): The tag's color. - body `update_automations` (boolean): Default true: automations that name the tag follow the rename. - example body: {"name":"Roof replacement","color":"amber"} - `POST /v1/tags/merge` — Merge tags into one (scope leads:write) Folds tags into the one you keep: their contacts get the kept tag and the others are deleted. Moving a tag is not adding it, so no "Tag added" automation starts. Automations that name a folded-in tag are rewritten to the kept one unless update_automations is false. Name tags by name or id. Owners and admins. - body `tags` (array, required): The tags to fold in (names or ids, up to 50). - body `into` (string, required): The tag to keep (name or id). - body `update_automations` (boolean): Default true. - example body: {"workspace_id":"uuid","tags":["roof","Roofing lead"],"into":"Roofing"} - `DELETE /v1/tags/{tag_id}` — Delete a tag (scope leads:write) Takes the tag off every contact for good. Automations that name it are left as they are. Owners and admins. - path `tag_id` (string, required): The tag (GET /v1/tags). ### Messaging - `POST /v1/messages` — Send an SMS, email, Instagram or Messenger message (scope messaging:write) Sends from the sub-account's own number / verified sending domain and logs the message on the lead timeline. Email requires a subject. Address the message with `lead_id`, or with a raw `to` (E.164 phone for SMS, email address for email) plus `workspace_id` — High Sierra Systems matches an existing contact or creates one. Every send counts against the daily unique-contact safety limit (300 contacts per UTC day by default); replies to contacts already messaged today are free of the cap. Over the cap the call answers 429. Each message is billed at the platform rate and counts against the key's monthly credit budget, if it has one (402 when the budget is used up); a text through one of the sub-account's iMessage Macs is free. A text or email (and an email's subject) can use the lead's variables, as in the Inbox and automations: {first_name}, {full_name}, {business_name} and the rest listed by GET /v1/workspace-automations/reference are filled in for the lead before it goes. The message is sent as the key's user, as from the Inbox: the conversation names them, the Activity Log records them, the numbers and Macs they may text from apply, and an archived conversation comes back to the Inbox. With `send_at` the message is scheduled instead, exactly like the Inbox's "Schedule message": the call answers 201 with the scheduled message, and at that time it is sent from the lead's usual number or sender as the key's user, with the same opt-out, credit and limit checks as a send now (a refusal then marks it failed with the reason). A contact who opted out, or has no phone or email for the channel, is refused up front (400). A scheduled message counts against the key's credit budget when it is scheduled. See, change, cancel or send it early with /v1/scheduled-messages. With `channel` instagram or messenger the message is a reply in the Instagram or Messenger conversation the lead started with the business (`lead_id` only), exactly like replying from the Inbox: text only (Instagram up to 1,000 characters, Messenger 2,000), sent now, through the connected account the lead wrote to last, as the key's user. Instagram and Messenger only allow it within 24 hours of the person's last message there: after that the call answers 409 `window_closed` with `reply_window_ends_at`; also 409 when the lead never messaged there (`no_social_contact`) or the account is switched off or needs connecting again (`channel_disabled`, `needs_reconnect`), and 403 `not_enabled` when Instagram & Messenger is off for the account. It is free, uses none of the credit budget (still refused once the budget is used up) and isn't counted in the daily contact limit. The answer carries `message_id` and `account_id` (GET /v1/social/accounts). - body `lead_id` (string): Lead to message. Omit when using `to`. Required for instagram and messenger. - body `to` (string): Raw destination: E.164 phone for sms, email address for email. Requires workspace_id. - body `channel` (string, required): sms, email, instagram or messenger. - body `body` (string, required): Message text. - body `subject` (string): Required for email. - body `name` (string): Contact name used when `to` creates a new lead. - body `media_urls` (array): Up to 10 MMS/attachment URLs. - body `actor_label` (string): Sender label shown in the timeline. - body `send_at` (string): Schedule instead of sending now: ISO 8601 with a time zone (Z or an offset), e.g. 2026-10-20T09:00:00-05:00. In the future and at most 365 days ahead. Answers 201 with `scheduled_message`. - body `send_as` (string): Texts, with an iMessage Mac connected (Beta): imessage sends a blue iMessage from one of the sub-account's iPhone numbers, sms from its business number, auto (default) lets the routing choose. The answer's `transport` says how it went (imessage, or mac_sms for the iPhone's own SMS). - body `imessage_line_id` (string): Texts: which Mac (iPhone number) sends it (GET /v1/imessage/lines). - body `audio_message` (boolean): Texts: the one media_urls file is a voice message. Through a Mac running Advanced mode it arrives as a real iMessage audio message; anywhere else as an audio attachment. Not with send_at. - example body: {"lead_id":"uuid","channel":"sms","body":"Hi Jane, are you still looking for a quote?"} - `GET /v1/scheduled-messages` — List scheduled texts and emails (scope messaging:read) Messages waiting to be sent later, scheduled in the Inbox or with POST /v1/messages and `send_at`. By default the upcoming ones (pending, sending, failed), soonest first, like the dashed bubbles at the end of a conversation; `status` = sent, cancelled or all lists history, newest first. A failed message carries `last_error`. Viewers limited to their own leads only see those leads' messages. - query `lead_id` (string): Only this lead's messages. - query `status` (string): Default upcoming (pending, sending, failed). - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `PATCH /v1/scheduled-messages/{scheduled_message_id}` — Change, cancel or restore a scheduled message (scope messaging:write) Like the Inbox's Edit, Cancel and Undo. Send any of body, subject (emails), scheduled_at and media_urls (texts) to change a pending or failed message: it goes back in the queue (status pending). `status: "cancelled"` (on its own) stops it; `status: "pending"` brings a cancelled one back (send a new scheduled_at when its time has passed). 409 when it is sending or already sent. Owners and admins only. - path `scheduled_message_id` (string, required): Scheduled message id. - body `body` (string): The new text. - body `subject` (string): The new subject (emails only). - body `scheduled_at` (string): ISO 8601 with a time zone, in the future and at most 365 days ahead. - body `media_urls` (array): Picture URLs for a text, max 10 (replaces the list). - body `status` (string): cancelled to cancel, pending to restore. - example body: {"scheduled_at":"2026-10-21T09:00:00-05:00","body":"Hi Jane, following up on your quote. Any questions?"} - `POST /v1/scheduled-messages/{scheduled_message_id}/send-now` — Send a scheduled message now (scope messaging:write; uses credits) The Inbox's "Send now": a pending or failed message goes out at once, as the teammate who scheduled it, with the usual opt-out, credit and limit checks, and is billed like any text or email. 200 = sent; 202 = a sending hiccup, it tries again by itself in a couple of minutes; 400 = refused, with the reason (the message is marked failed); 409 = cancelled, already sending or sent. Refused when the key's credit budget is used up. Owners and admins only. - path `scheduled_message_id` (string, required): Scheduled message id. - `GET /v1/messages` — List recent messages on this sub-account (scope messaging:read) Every SMS and email on the sub-account's High Sierra Systems numbers and inboxes, and every Instagram and Messenger DM, newest first. A DM has `channel` instagram or messenger, no from / to / subject, its pictures and files in `media_urls` and `social` { account_id: the connected account (GET /v1/social/accounts), sent_by: user, ai, automation or page (sent from the Instagram or Facebook apps) on the business's side }. For polling, pass `cursor` (or `since`) — results then come oldest-first and `next_cursor` walks forward with no duplicates and no missed messages. Poll no more than once every 10 seconds, or subscribe to the `message.received` webhook instead. A text that went through one of the sub-account's iMessage Macs carries `transport` (imessage, or mac_sms for the iPhone's own green text) and `imessage` { line_id, from, service: imessage | sms | rcs, delivered_at, read_at }; a tapback carries `reaction` { by: them | you, type, emoji, reacts_to: the message it hangs on, removed }. - query `lead_id` (string): Only messages with this contact. - query `channel` (string): sms, email, instagram or messenger. - query `direction` (string): inbound or outbound. - query `since` (string): ISO-8601 timestamp; returns messages created after it, oldest-first. - query `cursor` (string): `next_cursor` from the previous poll. - query `limit` (number): Default 50, max 200. - `GET /v1/messages/{message_id}` — Read one message (scope messaging:read) - path `message_id` (string, required): Message id from GET /v1/messages. - `GET /v1/messages/limits` — Check today's contact-safety limits (scope messaging:read) Returns the daily unique-contact cap (default 300 per UTC day), how many contacts have been used, what's left, segment usage and the reset time. The same values ride on every messaging call as X-Contacts-Limit / -Used / -Remaining / -Reset headers. - `GET /v1/leads/{lead_id}/conversation` — Read the conversation with a lead (scope messaging:read) Texts, emails, Instagram and Messenger DMs, website chat, calls, voicemails and notes, newest first. - path `lead_id` (string, required): Lead id. - query `limit` (number): Default 50. - `GET /v1/imessage/lines` — List the sub-account's iMessage Macs (scope messaging:read) Every Mac connected to the sub-account for iMessage, the default first: its iPhone number, whose Mac it is, whether it's online, what the Mac reports about itself (`health`: Messages signed in, Full Disk Access, awake, lid closed allowed, iCloud still syncing, the number missing from or switched off in Messages), whether Advanced mode runs on it (`advanced_mode`: real audio messages and reactions), its settings (scope, create_leads, new_conversations, fallback, offline_minutes, ai_replies), who can text from it (access, allowed_user_ids, and can_use for you), its limits (new conversations a day and an hour, tries and length before someone first replies) and today's usage (new conversations today and this hour, messages waiting, every text it sent today, and how many other accounts share that iPhone's limit). `has_number` says whether the sub-account has a business number to fall back on; without one every text goes through a Mac. Any member. Connecting and disconnecting a Mac happen in the app. - `PATCH /v1/imessage/lines/{line_id}` — Change an iMessage Mac's settings (scope messaging:write) Send only what changes. The sub-account's owners and admins change any Mac; everyone else only their own; only owners and admins choose the default (is_default: true moves it from the old one). access: everyone, owner (only the person whose Mac it is) or selected (allowed_user_ids); owners, admins and the Mac's owner can always text from it, and AI replies and automations aren't limited. - path `line_id` (string, required): The Mac (GET /v1/imessage/lines). - body `label` (string): A name for it (max 80), or null. - body `is_default` (boolean): true makes it the default Mac. - body `access` (string): Who can text from it by hand. - body `allowed_user_ids` (array): With access selected: the team members who can. - body `scope` (string): crm: only conversations with people already in the CRM sync; all: every one-to-one conversation. - body `create_leads` (boolean): With scope all: someone new who texts in becomes a lead. - body `new_conversations` (string): How a first text to someone goes. - body `fallback` (string): When they aren't on iMessage or the Mac is offline: the business number, RCS or SMS from the iPhone through the Mac, the iPhone and then the business number (mac_then_number, the default), or nothing. - body `offline_minutes` (number): How long a message waits for an offline Mac before the fallback, 2-240. - body `ai_replies` (boolean): The AI texter may answer iMessages. - example body: {"access":"selected","allowed_user_ids":["uuid"],"new_conversations":"imessage"} - `POST /v1/messages/{message_id}/reaction` — React to an iMessage (tapback) (scope messaging:write) Puts a tapback (❤️ 👍 👎 😂 ‼️ ❓) on a text that went through one of the sub-account's Macs, like the Inbox's reaction picker; `remove: true` takes yours back. Only a Mac running Advanced mode can (`advanced_mode` on GET /v1/imessage/lines): otherwise 409 `advanced_off`. The reaction is queued (202) and shows on the message (its `reaction`, by you) once the Mac has sent it; if it can't, a note says why on the conversation. Anyone who can see the lead and text from that number. Free, like every text through a Mac. - path `message_id` (string, required): The text to react to (an id from GET /v1/messages or the lead's conversation). - body `reaction` (string, required): love, like, dislike, laugh, emphasize or question (or the emoji). - body `remove` (boolean): true takes your reaction back. - example body: {"reaction":"love"} - `PUT /v1/imessage/automated-texts` — Choose who automated texts send from (scope messaging:write) Settings > Phone's "Automated texts send from" (also on the Automations page): the way the texts the sub-account sends on its own go once it has a Mac connected. Automations, appointment confirmations and reminders, follow-ups and first texts follow it; an AI reply to a customer's own text still answers the way they wrote, and a step or send that names its own way keeps it. automatic lets each iPhone's iMessage settings decide, number sends from the business number, a line_id from that iPhone. GET /v1/imessage/lines returns the current choice as automated_texts_send_from. Owners and admins. - body `send_from` (string, required): automatic, number, or the line_id of a connected iPhone (GET /v1/imessage/lines). - example body: {"workspace_id":"uuid","send_from":"number"} - `GET /v1/social/accounts` — List the connected Instagram and Messenger accounts (scope messaging:read) The Instagram accounts and Facebook Pages (Messenger) connected in Settings > Instagram & Messenger: whether each is on, whether the AI answers its DMs (`ai_replies`), its connection (`status` connected, needs_reconnect or error, with `last_error`) and `live`: replies can go out through it. Any member. Connecting and switching accounts happen in the app. 403 `not_enabled` when Instagram & Messenger is off for the account. - `GET /v1/social/comments` — Instagram and Facebook comments the comment-to-DM rules saw (scope messaging:read) Recent comments in Settings > Instagram & Messenger: every comment a comment-to-DM rule matched, newest first, with the post, who wrote it, the rule, whether a public reply went under it, what happened to the DM (`dm_status` sent, failed with `error`, or skipped: that person already got it) and the lead it started a conversation with. `counts` has the number per result with every other filter applied; page with `offset` (`next_offset`). To answer someone, reply in their conversation with POST /v1/messages (channel instagram or messenger). Owners and admins. - query `status` (string): What happened to the DM. - query `account_id` (string): One connected account (GET /v1/social/accounts). - query `rule_id` (string): One comment-to-DM rule. - query `post_id` (string): One post or reel. - query `commenter_id` (string): Everything from one person (commenter.id). - query `search` (string): Commenter name or comment text contains (max 100). - query `from` (string): ISO date or time, comments on or after. - query `to` (string): ISO date or time, comments on or before. - query `oldest_first` (boolean): Default false (newest first). - query `limit` (number): 1-100, default 25. - query `offset` (number): next_offset from the previous page. ### Bookings - `GET /v1/calendars` — List booking calendars (scope bookings:read) Every setting POST / PATCH /v1/calendars takes, read the way the booking page reads it: hours, length, buffers, hosts' mode, texts, pricing (with each option's and add-on's id, used by availability and bookings), design, duration_days (full-day jobs), schedule_group (shared schedule), fields and questions (the booking form), image_url, the payment settings, a summary (price_from_cents, price_to_cents, length_label such as "4-6 hr", has_options, takes_payment) and booking_path (/c/). - `GET /v1/calendars/{calendar_id}/availability` — Get open appointment slots (scope bookings:read) The times the calendar's booking page offers, worked out the same way: weekly hours and days off, the job length, buffers, capacity (slots_per_window jobs at one moment), calendars sharing its schedule, max per day, minimum notice, the booking window (max_days_ahead, up to a year) and the hosts' own calendars. A calendar with options times each one differently, so send option_id (400 lists the options otherwise) and any addon_ids; the answer carries a quote (option, add-ons, length, total, deposit, balance). Full-day calendars also return slot_ends (when each start's job is done). Always call this before creating a booking. - path `calendar_id` (string, required): Calendar id. - query `from` (string): A date (2026-11-03) or an ISO time; defaults to today. - query `days` (number): 1-42, default 7. - query `option_id` (string): The option picked (its id in GET /v1/calendars pricing.options). Required on a calendar with options. - query `addon_ids` (string): Add-on ids, comma-separated: they add their time to the job. - `GET /v1/bookings` — List appointments (scope bookings:read) Soonest first. Each appointment has the same fields as everywhere else in the API: id, lead_id, calendar_id, appointment_number (the sub-account's #1001 and up, as the calendar shows it), title, starts_at, ends_at, timezone, lead_timezone, location, notes, meeting_type, meeting_location, meeting_url, host_user_id, status, source, notify_lead, is_arrival_window (booked as an arrival window: starts_at to ends_at is the window), service_details (on a priced calendar: the service, option, add-ons, length, total_cents, deposit_cents, balance_cents and currency; null otherwise), created_at and updated_at. - query `from` (string): ISO start. - query `to` (string): ISO end. - query `status` (string): Filter by status. - query `lead_id` (string): Filter by lead. - `POST /v1/bookings` — Book an appointment (scope bookings:write) Books like the app: rejects a second overlapping appointment for the same lead; calendar_id must be one of the sub-account's calendars (404 otherwise); ends_at must be after starts_at and at most 24 hours later. With a calendar, the slot's capacity is checked, calendars sharing its schedule included (409 with code slot_full; pick a time from GET /v1/calendars/{calendar_id}/availability, or send force: true) and the host is picked by the calendar's round robin. On a priced calendar, option_id and addon_ids set the job's length and price: the booking's notes start with the pick and its service_details carry the option, add-ons, total, deposit and balance; the lead's deal value is filled when it has none (the response adds a quote; a warning says when a calendar with options was booked without one). Bookings made through the API never take the deposit: to collect it, send the customer the booking link. A full-day calendar's job starts at opening time and ends at closing time on its last working day (400 not_a_start_time otherwise, unless ends_at is sent). By default the lead gets the confirmation and reminder texts and the calendar invite (notify_lead: false to skip them). Fires the appointment.booked outbound webhooks. - body `starts_at` (string, required): ISO 8601 start time. - body `ends_at` (string): ISO 8601 end time (instead of duration_minutes; at most 24 h after starts_at, 31 days on a full-day calendar). - body `lead_id` (string): Lead to book. - body `calendar_id` (string): One of the sub-account's calendars. - body `option_id` (string): The option booked (GET /v1/calendars pricing.options id), e.g. the vehicle size. - body `addon_ids` (array): Add-ons booked (pricing.addons ids). - body `duration_minutes` (number): 5-1440. Default: the option's length with its add-ons, else the calendar's, else 30. - body `timezone` (string): IANA timezone. - body `location` (string): Meeting location. - body `notes` (string): Internal notes. - body `notify_lead` (boolean): Default true: the lead gets the confirmation email with its calendar invite plus the confirmation and reminder texts. false books quietly, and later updates or cancels stay quiet too; the host still gets the booking alert. - body `force` (boolean): Skip the calendar's capacity check (the database still never double-books a person or a full calendar). - example body: {"workspace_id":"uuid","lead_id":"uuid","calendar_id":"uuid","starts_at":"2026-11-03T14:00:00Z","option_id":"opt-van","addon_ids":["add-pet"]} - `POST /v1/bookings/{booking_id}/reschedule` — Move an appointment (scope bookings:write) Re-times the reminder texts, updates the calendar mirror and the lead's invite, and fires the appointment.rescheduled outbound webhooks when the time changed. The appointment keeps its length; a full-day job runs to closing time on its new last working day. 409 slot_full when the new time is taken. - path `booking_id` (string, required): Booking id. - body `starts_at` (string, required): New ISO start time. - body `duration_minutes` (number): Optional new length, 5-1440. - `POST /v1/bookings/{booking_id}/cancel` — Cancel an appointment (scope bookings:write) DELETE /v1/bookings/{booking_id} does the same. - path `booking_id` (string, required): Booking id. - body `reason` (string): Cancellation reason. - `PATCH /v1/bookings/{booking_id}` — Change an appointment's outcome, title, notes, location, host, lead notifications or lead (scope bookings:write) Everything but the time (use reschedule for that). status records the outcome: completed, no_show or cancelled release the lead from Booked and stop its reminder texts; confirmed puts it back on. host_user_id must be someone on the sub-account's team (GET /v1/members). notify_lead: false silences the lead's remaining reminder texts and invite updates; true turns them back on (an upcoming appointment's reminders are queued again). lead_id links an appointment that has no lead yet (typed in by hand) to a lead of the same sub-account; one that already has a lead answers 409. Linking an upcoming scheduled appointment books it for the lead like a new booking: the lead is marked booked, its follow-ups and AI calls stop, and the confirmation and reminder texts and the invite go out (unless notify_lead is false). A past or finished appointment is only linked. - path `booking_id` (string, required): Booking id. - body `status` (string): The appointment's outcome. - body `title` (string): Max 200. - body `notes` (string): Max 2000. null clears them. - body `location` (string): Address or place, max 300. null clears it. - body `host_user_id` (string): Team member who takes it. null for nobody. - body `notify_lead` (boolean): false: the lead gets no more reminder texts or invite updates for this appointment. true: they do again. - body `lead_id` (string): Link an appointment with no lead to this lead (same sub-account). Cannot move an appointment from one lead to another. - example body: {"status":"completed","notes":"Signed the quote on site."} ### Members - `GET /v1/members` — List sub-account members and invites (scope members:read) Each member has user_id, role, email and full_name. Use user_id (or the email) to name a team member in busy blocks. Staff and Technicians, who have no Team page in the app, get names and roles only (no emails, no invitations). - `POST /v1/members` — Invite a member (scope members:admin) - body `email` (string, required): Invitee email. - body `role` (string): client_admin (Admin), client_viewer (Staff) or client_tech (Technician: only their own leads and appointments). Default client_viewer. - `PATCH /v1/members/{member_id}` — Change a member's role (scope members:admin) You cannot change your own role. - path `member_id` (string, required): Member id. - body `role` (string, required): client_admin (Admin), client_viewer (Staff) or client_tech (Technician: only their own leads and appointments). - `DELETE /v1/members/{member_id}` — Remove a member (scope members:admin) - path `member_id` (string, required): Member id. ### Smart forms - `GET /v1/smart-forms` — List smart forms (scope smart_forms:read) - `GET /v1/smart-forms/{form_id}/submissions` — List form submissions (scope smart_forms:read) - path `form_id` (string, required): Form id. - query `limit` (number): Default 50. ### CRM automations - `GET /v1/workspace-automations` — List sub-account automations (scope workspace_automations:read) - `POST /v1/workspace-automations/{automation_id}/enroll` — Enroll leads into an automation (scope workspace_automations:write) Can send real texts and emails. Confirm the lead list before calling. Leads are queued and start within the sub-account's daily contact limit. A lead already waiting in this automation's queue is not queued again (already_queued). ignore_filters defaults to false: a lead that fails the automation's only_if rules is skipped when the queue reaches it (the app's Enroll dialog defaults to true). - path `automation_id` (string, required): Automation id. - body `lead_ids` (array, required): Lead ids (max 5000). - body `ignore_filters` (boolean): Default false: leads that fail the automation's only_if rules are skipped. true = enroll them anyway. - example body: {"lead_ids":["uuid"],"ignore_filters":false} - `POST /v1/workspace-automations/{automation_id}/toggle` — Enable or disable a sub-account automation (scope workspace_automations:write) - path `automation_id` (string, required): Automation id. - body `enabled` (boolean): Omit to flip the current state. - `GET /v1/workspace-automations/reference` — Every trigger, step, filter and setting the builder accepts (scope workspace_automations:read) Read this before building: trigger types and their filters, step actions and their fields, entry-rule fields and operators (with every lead source), settings, message variables, and what this sub-account has for a definition to point at: stages, team, custom fields, phone numbers, review funnel, Facebook pages, Smart Forms, form names (for form_name rules), calendars and email senders. - `POST /v1/workspace-automations` — Build an automation (scope workspace_automations:admin) Saved exactly as the Automations page saves it, so it opens and edits in the app. Saved OFF unless enabled is true; once on, its texts and emails go to real leads through the normal quiet hours, opt-out and daily limits. Steps can send lead data out (webhooks, alerts), so this needs an admin-scoped key. Everything it points at (stages, team members, phone numbers, review pages, Facebook pages, Smart Forms, calendars, email senders) must be in the same sub-account; GET /v1/workspace-automations/reference lists them. Any step can take a label (its name on the step card). Steps include drip (let a number of leads through every period, the rest wait in line, within business hours if asked); triggers include custom_field_changed (a custom field changes, optionally to certain values or only by a person). An inbound_webhook automation comes back with its private inbound_url: POST JSON with a phone or email to start it (it must be on), and every field sent can be used in its messages as {field}. - body `name` (string, required): Up to 80 characters. - body `description` (string): Optional note. - body `trigger` (object, required): When it starts: {"type":"new_lead"}, {"type":"stage_changed","to_stages":["booked"]}, {"type":"tag_added","tags":["hot"]}, {"type":"leads_imported","tags":["Foreclosure list"]}, {"type":"smart_form_submitted","form_ids":["Free quote"]}, {"type":"appointment_booked","calendar_ids":["Estimate visit"]}, {"type":"inbound_webhook"}... Ids or names. See GET /v1/workspace-automations/reference. - body `only_if` (array): Entry rules, all must hold: [{"field":"tags","op":"has_none","value":["customer"]}]. - body `steps` (array, required): In order: [{"action":"send_text","message":"Hi {first_name}"},{"action":"wait","days":1},{"action":"send_email","subject":"Your quote","message":"..","from_sender_id":""},{"action":"if","conditions":[..],"then":[..],"else":[..]}]. A send_text step takes send_as (auto, imessage or sms) when the sub-account has an iMessage Mac. - body `settings` (object): {"stop_on_reply":true,"sending_window":{"days":["mon","tue"],"start":"09:00","end":"18:00"}}. - body `enabled` (boolean): Default false. - example body: {"workspace_id":"uuid","name":"Speed to lead","trigger":{"type":"new_lead"},"steps":[{"action":"send_text","message":"Hi {first_name}, thanks for reaching out! When is a good time to talk?"},{"action":"wait","days":1},{"action":"send_text","message":"Still interested, {first_name}?"}],"settings":{"stop_on_reply":true}} - `GET /v1/workspace-automations/{automation_id}` — One automation as {trigger, only_if, steps, settings} (scope workspace_automations:read) The same shape create and update take (step names included), with a ref on every step so an update can keep steps unchanged ({"keep":""}). Webhook header values are hidden. An inbound_webhook automation includes its inbound_url; viewers see only its host, like webhook step links. - path `automation_id` (string, required): Automation id. - `PATCH /v1/workspace-automations/{automation_id}` — Change an automation (scope workspace_automations:admin) Send only what changes. steps replaces all steps: keep unchanged ones with {"keep":""} from GET. settings changes only the keys sent. enabled turns it on or off. - path `automation_id` (string, required): Automation id. - body `name` (string): New name. - body `trigger` (object): New trigger. - body `only_if` (array): New entry rules. - body `steps` (array): New steps (replaces all). - body `settings` (object): Settings to change. - body `enabled` (boolean): On or off. - `POST /v1/workspace-automations/{automation_id}/duplicate` — Copy an automation (scope workspace_automations:admin) The copy is saved OFF unless enabled is true. - path `automation_id` (string, required): Automation id. - body `name` (string): The copy's name. - body `enabled` (boolean): Default false. - `DELETE /v1/workspace-automations/{automation_id}` — Delete an automation (scope workspace_automations:admin) Leads inside it stop where they are. - path `automation_id` (string, required): Automation id. - `GET /v1/workspace-automations/folders` — List automation folders (scope workspace_automations:read) The folders on the Automations page in their order, the automations in each, and the ones at the top level. GET /v1/workspace-automations also takes folder_id (or none for the top level). - `POST /v1/workspace-automations/folders` — Create an automation folder (scope workspace_automations:write) Added after the existing folders. Owners and admins. - body `name` (string, required): Up to 60 characters. - example body: {"workspace_id":"uuid","name":"Reminders"} - `PATCH /v1/workspace-automations/folders/{folder_id}` — Rename an automation folder (scope workspace_automations:write) - path `folder_id` (string, required): The folder. - body `name` (string, required): Up to 60 characters. - example body: {"name":"Appointment reminders"} - `DELETE /v1/workspace-automations/folders/{folder_id}` — Delete an automation folder (scope workspace_automations:write) Its automations move to the top level, unchanged (nothing is turned off or deleted). - path `folder_id` (string, required): The folder. - `POST /v1/workspace-automations/move` — Move automations into a folder (scope workspace_automations:write) Puts the automations into the folder, or back to the top level with folder_id null. Only where they show on the page changes. - body `automation_ids` (array, required): Up to 100 automations of the sub-account. - body `folder_id` (string, required): The folder, or null for the top level. - example body: {"workspace_id":"uuid","automation_ids":["uuid"],"folder_id":"uuid"} - `GET /v1/workspace-automations/{automation_id}/enrollments` — Who is inside an automation right now (scope workspace_automations:read) Leads waiting on a step or mid-step, newest first, with the time their next step runs, plus how many are still waiting to be enrolled. - path `automation_id` (string, required): Automation id. - query `limit` (number): 1-100, default 100. - query `cursor` (string): next_cursor from the previous page. - `POST /v1/workspace-automations/{automation_id}/unenroll` — Take leads out of an automation (scope workspace_automations:write) Like Remove from workflow in the app: their run stops, queued steps (texts, emails) are cancelled and the lead's timeline notes it. Nothing is sent. - path `automation_id` (string, required): Automation id. - body `lead_ids` (array): Up to 500 lead ids. - body `all` (boolean): true = everyone in it (instead of lead_ids). - example body: {"lead_ids":["uuid"]} - `GET /v1/leads/{lead_id}/workflows` — The automations a lead is inside (scope workspace_automations:read) - path `lead_id` (string, required): Lead id. ### Workspaces - `GET /v1/workspaces` — List sub-accounts (scope workspaces:read) - `GET /v1/workspaces/{workspace_id}` — Get one sub-account (scope workspaces:read) - `PATCH /v1/workspaces/{workspace_id}` — Update a sub-account (scope workspaces:write) Send only what changes: name, timezone, industry, logo_url, brand_id, archived, notify_on_appointments, enabled_features, hidden_features. logo_url is the sub-account's Client logo, the same image as Settings → Client logo & app icon: changing either changes both (null removes it). enabled_features is Settings > Features: tools only some businesses use, off until turned on (today: sales, the Sales page and the parts / tip / technician on won jobs; plans, Plans & memberships on won jobs); owners and admins. hidden_features is what the agency hides from the sub-account's own people (client admins, Staff and Technicians lose those pages, and their API keys get 403 feature_off on those routes): leads, messages, appointments, calendars, smart_forms, media, campaigns, calls, ai_voice, automations, landing_pages, invoices, sales, activity, team, ad_insights, tools, support, agent. archived, brand_id and hidden_features are the agency's: the owner or an agency admin. Both take { key: true | false } and change only the keys sent. - body `logo_url` (string): Client logo URL, or null to remove it. - body `enabled_features` (object): Settings > Features, e.g. { "sales": true }. - body `hidden_features` (object): Hidden from the client's people, e.g. { "invoices": true, "team": false }. Owner or agency admin. - example body: {"enabled_features":{"sales":true}} - `POST /v1/workspaces/{workspace_id}/outreach` — Configure outreach (auto-greet, AI replies, sending identity) (scope workspaces:write) Raw column names, for anyone who can manage the sub-account; PATCH on the same path does the same. Prefer PATCH /v1/ai-texting and /v1/nurture-sequence, which take friendly names and check every value. Accepted fields: auto_greet_new_leads, first_message_template, sms_template, greet_delay_minutes_smart_form, greet_delay_minutes_default, greet_window_mode / _start / _end, followup_window_mode / _start / _end, ai_enabled, ai_system_prompt, ai_business_context, ai_agent_name, ai_booking_link, ai_max_auto_replies, reply_delay_minutes, respect_business_hours, quiet_hours_enabled / _start / _end, handoff_on_unknown, handoff_pause_ai, handoff_resume_days, ai_can_cancel_appointments, ai_cancel_retention_enabled, ai_cancel_retention_note, ai_auto_resume_minutes, nurture_enabled, nurture_steps, email_enabled, email_from_address, email_from_name, email_subject, email_template, sms_enabled, missed_call_text_enabled, missed_call_text_body, reminder_24h_enabled / _template, reminder_1h_enabled / _template, reminder_5m_enabled / _template (the 5-minute reminder, off by default), customer_confirmation_enabled / _template, appointment_email_enabled, appointment_email_language (en | es). Unknown fields are ignored; text is capped at 20,000 characters. - body `auto_greet_new_leads` (boolean): Text new leads automatically. - body `first_message_template` (string): The first text. - body `ai_enabled` (boolean): AI replies on or off. - body `ai_agent_name` (string): Name the AI texts as. - body `email_from_name` (string): Sender name on emails. - example body: {"auto_greet_new_leads":true,"ai_enabled":true,"ai_agent_name":"Sarah"} ### Setup - `GET /v1/setup-status` — What is set up, and what is missing (scope workspaces:read) Start here. Returns the sub-account's real configuration (numbers, AI texting, receptionist, calendars, forms, automations, offers, team, lead sources, integrations) and a severity-ranked list of findings. Each finding names the API call and MCP tool that fixes it, or says when it can only be done in the app (buying a number, SMS registration, connecting Google or Outlook). ### Offers - `GET /v1/offers` — List offers (scope workspaces:read) Offers (offer playbooks) tell the AI what this business sells to a lead: the first text, the follow-up sequence, notes for the AI and the booking link. - `POST /v1/offers` — Create an offer (scope workspaces:write) - body `name` (string, required): Internal name (max 80). - body `offer_label` (string): How the offer is described to the lead (max 200). - body `first_message_template` (string): First text to a new lead. Supports {{first_name}} (max 1600). - body `nurture_enabled` (boolean): null follows the sub-account's own follow-up setting. - body `nurture_steps` (array): Up to 12 follow-ups: { offset_minutes, body_template }. offset_minutes counts from the previous message. - body `ai_context_note` (string): What the AI should know about this offer (max 2000). - body `booking_link` (string): Public http(s) URL. - body `is_active` (boolean): Default true. - body `smart_first_text_enabled` (boolean): true: the AI writes the first text for these leads (first_message_template is the backup); false: first_message_template goes out as written; null (default) follows the sub-account's smart first text switch. - body `smart_first_text_instructions` (string): What the smart first text should do for these leads (max 1000). Empty uses the sub-account's instructions. - body `triggers` (array): Which leads get this offer: { type, value, label? }. type is meta_form, smart_form, webhook (a lead source id) or source (the lead's source text). Form and lead-source ids must belong to the sub-account. - example body: {"workspace_id":"uuid","name":"Free roof inspection","offer_label":"a free 20-point roof inspection","first_message_template":"Hi {{first_name}}, thanks for asking about a free roof inspection. What day works best?","nurture_steps":[{"offset_minutes":60,"body_template":"Still want that inspection?"}],"triggers":[{"type":"source","value":"Website form"}]} - `PATCH /v1/offers/{offer_id}` — Update an offer (scope workspaces:write) Send only what changes. `triggers`, when sent, replaces the whole list. - path `offer_id` (string, required): Offer id. - `DELETE /v1/offers/{offer_id}` — Delete an offer (scope workspaces:admin) - path `offer_id` (string, required): Offer id. ### Calendars & hours - `POST /v1/calendars` — Create a booking calendar (scope bookings:write) A new calendar has no host unless host_user_id or hosts is sent. Hosts must be members of the sub-account (GET /v1/members). The response is the calendar as GET /v1/calendars shows it, with its public booking path (/c/). Calendars are switched off with is_active=false rather than deleted. The booking page can show prices with options and add-ons and take a deposit (pricing), have its own look (design), book whole working days (duration_days), share one schedule with other calendars (schedule_group) and ask its own questions (questions). Taking money at booking needs Stripe, Authorize.net or Whop connected to the sub-account in the app first. - body `name` (string, required): Calendar name (max 80). - body `title` (string): Shown to the person booking. - body `duration_minutes` (number): 5-1440, default 30. - body `buffer_minutes` (number): 0-1440, default 0. Always saved as 0 on an arrival_window calendar (a window books the whole window and pads nothing), as in the app. - body `min_notice_minutes` (number): Default 60. - body `max_days_ahead` (number): 1-365, default 14. - body `timezone` (string): IANA zone, e.g. America/Chicago. Defaults to the sub-account's. - body `weekly_hours` (object): Per day, 24h HH:MM windows: {"mon":[["09:00","17:00"]],"sat":[]}. Default Mon-Fri 9-5. - body `date_overrides` (array): Days off or special hours: [{"date":"2026-12-25","pairs":[]}]. - body `assignment_mode` (string): Who takes the booking. Default unassigned (no host), or single when host_user_id is sent. - body `host_user_id` (string): Host of a single-host calendar (required for single). - body `hosts` (array): User ids sharing a round_robin / collective calendar. - body `meeting_type` (string): Default phone. in_person: the customer comes to meeting_location (studio, shop, office). customer_address: the team goes to the customer's home, and the booking page asks for their address. - body `scheduling_mode` (string): exact times, or an arrival window for trades. - body `arrival_window_minutes` (number): 15-720. - body `appointment_texts` (object): Confirmation and reminder texts for appointments on this calendar, keyed by confirmation, reminder_24h, reminder_1h, reminder_5m. Each takes {"mode":"custom","template":"..."} (this wording, sent even when the sub-account has that text off), {"mode":"off"} (never sent for this calendar), or null / {"mode":"inherit"} (the sub-account's text, the default). Only the texts you name change. - body `slots_per_window` (number): 1-50: how many jobs can run at the same moment (crews). - body `duration_days` (number): Full-day jobs, 1-14 working days: each booking runs from opening time on its first day to closing time on its last, skipping closed days. null = timed by duration_minutes. - body `schedule_group` (string): Shared schedule name (max 60): calendars with the same group count each other's bookings, so one crew's time is never sold twice across services. null = its own schedule. - body `pricing` (object): Prices on the booking page. Merged into what the calendar has, except options and addons, which replace their lists (send each row's id to keep it; ids come back in GET /v1/calendars). Money in cents. { enabled, show_prices, price_cents (no options), price_note (max 160), options_label ("Vehicle size"), options: [{ id?, name (max 80), description?, price_cents, duration_minutes (5-1440, its own job length), duration_days (full-day calendars), image_url? }] (max 24; the customer picks one), addons_label, addons: [{ id?, name, description?, price_cents, extra_minutes (0-720), image_url? }] (max 24), deposit: { mode: none | fixed | percent | full, amount_cents, percent (1-100) } }. A calendar that never had pricing switches it on unless enabled is false; null clears it. A deposit needs a connected gateway. - body `design` (object): The booking page look, merged into the current design. { enabled, preset (clean, showroom, midnight, fresh, warm, bold, ocean, spa, mono, graphite: applied first), mode: light | dark | auto, colors: { background, surface, text, button } (#rrggbb, merged), font, heading_font ("match" or a font), radius: sharp | soft | rounded | pill, button_style: solid | soft | outline, backdrop: solid | glow | photo, logo_url, cover_url (https), hide_avatar, custom_css (max 12000) }. Fonts: inter, poppins, dm-sans, space-grotesk, manrope, outfit, figtree, plus-jakarta, work-sans, rubik, nunito-sans, montserrat, raleway, urbanist, sora, lexend, archivo, barlow, karla, public-sans, bricolage, bebas, anton, archivo-black, syne, clash, oswald, playfair, dm-serif, lora, libre-baskerville, cormorant, instrument-serif, fraunces, source-serif, merriweather, jetbrains-mono, space-mono, ibm-plex-mono, system. A page that never had a design switches it on unless enabled is false; null = the classic page. It carries into embeds and custom domains. - body `questions` (array): The calendar's own booking questions, up to 30, replacing the list: [{ key?, label (max 160), field_type: text | textarea | number | money | phone | email | url | select | multiselect | boolean | date | datetime | rating | file (photos or PDFs, up to 6), options (select / multiselect: 2-40), option_style?, required?, enabled?, save_to_crm? (never for file), placeholder?, helper_text? }]. Answers show on the appointment and the lead. - body `fields` (object): Contact fields on the booking form, merged: {"address":{"enabled":true,"required":true,"autocomplete":true},"email":{"required":false}}. Keys: full_name, first_name, last_name, email, phone, address, state, notes. Phone or email stays on; full_name or first_name + last_name. - body `image_url` (string): The service's photo (https): on its booking page and its service menu card. - body `currency` (string): Prices and payments in this currency. - body `payment_gateway` (string): Charge through this connected gateway; null = whichever is connected (Stripe first). - body `payment_hold_minutes` (number): 15-120: how long the time is held while they pay. - body `payment_label` (string): What the checkout calls the payment, e.g. "Deposit" (max 60). - example body: {"workspace_id":"uuid","name":"Triple T Interior + Exterior","duration_minutes":240,"assignment_mode":"unassigned","schedule_group":"Main crew","max_days_ahead":120,"pricing":{"options_label":"Vehicle size","options":[{"name":"Car","price_cents":31500,"duration_minutes":240},{"name":"SUV","price_cents":38500,"duration_minutes":300},{"name":"Van","price_cents":53500,"duration_minutes":360}],"addons":[{"name":"Pet hair","price_cents":4000,"extra_minutes":30}],"deposit":{"mode":"fixed","amount_cents":5000}},"design":{"preset":"showroom"},"questions":[{"label":"Vehicle year / make / model","field_type":"text","required":true},{"label":"Photos of the vehicle","field_type":"file"}]} - `PATCH /v1/calendars/{calendar_id}` — Update a booking calendar (scope bookings:write) Takes the same fields as create; send only what changes. `hosts`, when sent, replaces the pool; people who stay keep their place in the rotation. An arrival_window calendar always keeps buffer_minutes at 0 (a full-day one keeps its buffer). `appointment_texts` changes only the texts it names. pricing, design and fields merge; pricing.options, pricing.addons and questions replace their lists. Turning pricing off also stops taking payment at booking. - path `calendar_id` (string, required): Calendar id. - example body: {"pricing":{"deposit":{"mode":"percent","percent":20}},"design":{"colors":{"button":"#d4a63a"}}} - `POST /v1/calendars/{calendar_id}/copy-design` — Copy a calendar's design to others (scope bookings:write) The Design tab's "Use on other calendars": this calendar's design goes onto the calendars named (or every other calendar of the sub-account with all: true), switched on. A calendar that has its own cover photo keeps it. The calendar must have a design switched on. - path `calendar_id` (string, required): The calendar whose design is copied. - body `calendar_ids` (array): The calendars to copy it to. - body `all` (boolean): Every other calendar of the sub-account instead. - example body: {"all":true} - `POST /v1/calendars/{calendar_id}/design/generate` — Design a booking page with AI (scope bookings:write) The Design tab's AI designer: describe the look in one line and/or give the business's website (its colours, fonts and logo are read from it). Returns the design and a one-line summary, and saves it on the calendar unless save is false. readable says whether the text reads well on the card. No credits used. - path `calendar_id` (string, required): Calendar id. - body `instruction` (string): What it should look like, e.g. "black and gold, like a luxury showroom" (max 1200). - body `website_url` (string): The business's website. - body `save` (boolean): Default true. false only returns the design (send it later with PATCH design). - example body: {"instruction":"black and gold, like a luxury showroom","website_url":"https://example.com"} - `GET /v1/booking-menus` — List service menus (scope bookings:read) Service menus (Calendars → Booking tools → Service menu): one booking link (/c/, public_path) that lists several calendars in sections, with search, category chips and sorting; the customer picks a service and books it there. Each section lists its services with their price and length as the page shows them. warnings says when its services are on separate schedules (two customers could book the same time on different services) or switched off. - `POST /v1/booking-menus` — Create a service menu (scope bookings:write) Without sections it starts like the app's: one "Services" section with every calendar that is switched on, and a link named after the business. The link shares /c/ with calendars, so a slug a calendar or another menu uses answers 409. - body `title` (string): Heading customers see (max 120). Default "Book a service". - body `name` (string): Internal name (max 80). Default "All services". - body `description` (string): Under the heading (max 600). - body `slug` (string): Link name: /c/ (letters, numbers, dashes; max 40). - body `sections` (array): In order, replacing the list: [{ id?, title (max 80), description?, calendar_ids: [calendar ids, in the order shown] }]. Up to 30 sections; every calendar must belong to the sub-account. - body `options` (object): Merged: { show_prices, show_durations, search, filters (category chips), sorting, default_sort: featured | price_low | price_high | shortest | name }. All on by default. - body `design` (object): The page look, the same shape as a calendar's design. It carries into each service's booking flow opened from the menu. - body `is_active` (boolean): Default true. - example body: {"workspace_id":"uuid","title":"Book a detail","sections":[{"title":"Quick Services","calendar_ids":["uuid","uuid"]},{"title":"Detailing Packages","calendar_ids":["uuid"]}],"design":{"preset":"showroom"}} - `PATCH /v1/booking-menus/{menu_id}` — Update a service menu (scope bookings:write) Takes the same fields as create; send only what changes. sections replaces the list; options and design merge. - path `menu_id` (string, required): Menu id. - example body: {"options":{"default_sort":"price_low"}} - `DELETE /v1/booking-menus/{menu_id}` — Delete a service menu (scope bookings:write) Its link stops working; the calendars on it are not touched. - path `menu_id` (string, required): Menu id. - `POST /v1/booking-menus/{menu_id}/share-schedule` — Put a menu's services on one schedule (scope bookings:write) The menu editor's "Share one schedule": every calendar on the menu gets the same schedule_group, so a booking on any of them takes that time on all of them (one crew doing every service). group names it; by default the group one of them already has, else the menu's title. - path `menu_id` (string, required): Menu id. - body `group` (string): The shared schedule's name (max 60). - `POST /v1/booking-menus/{menu_id}/design/generate` — Design a service menu with AI (scope bookings:write) Same as POST /v1/calendars/{calendar_id}/design/generate, for a service menu's page. - path `menu_id` (string, required): Menu id. - body `instruction` (string): What it should look like. - body `website_url` (string): The business's website. - body `save` (boolean): Default true. - `GET /v1/availability` — Get business hours and booking defaults (scope bookings:read) - `PUT /v1/availability` — Set business hours and booking defaults (scope bookings:write) The AI uses these to decide when it may text and which times to offer. Setting the time zone also updates the sub-account's time zone. - body `timezone` (string): IANA zone. - body `weekly_hours` (object): Same shape as a calendar's. - body `date_overrides` (array): Days off or special hours. - body `slot_minutes` (number): 5-240. - body `buffer_minutes` (number): 0-120. Always saved as 0 when scheduling_mode is arrival_window. - body `default_calendar_id` (string): A calendar of this sub-account, or null. - example body: {"workspace_id":"uuid","timezone":"America/Chicago","weekly_hours":{"mon":[["08:00","17:00"]],"sat":[["09:00","13:00"]]}} - `GET /v1/calendar-routes` — List calendar routing rules (scope bookings:read) Calendar routing (Calendars -> Calendar routing in the app) sends each lead to the calendar that fits their answers: "Player group is Girls 13-14 -> Girls 13-14 calendar". Rules are checked in order (`position` 1 first); the first rule whose conditions ALL match the lead's custom fields or tags picks the calendar. Smart Forms with calendar_routing on, the AI texter and the AI caller follow them. Each rule comes with its calendar's name and a readable `summary`. Rules that are switched off, or whose calendar is off, are skipped. - `POST /v1/calendar-routes` — Add a calendar routing rule (scope bookings:write) Added last unless you send `position`. Conditions: a field condition reads a custom field by key (GET /v1/custom-fields) with op is, is_not or contains and `values` (any one matches), or op between with min and/or max for numbers ("11 years old" counts as 11); a tag condition (kind tag, op is or is_not) reads the lead's tags. Answers compare ignoring case, accents and punctuation. The calendar must belong to the sub-account. `warnings` explains a rule that may never fire (a key that is not a custom field, a calendar that is switched off). Owners and admins only; at most 200 rules. - body `calendar_id` (string, required): The calendar this rule books on (GET /v1/calendars). - body `conditions` (array, required): All must match, 1-20: [{"kind":"field","key":"player_group","op":"is","values":["Girls 13-14"]}], [{"kind":"field","key":"age","op":"between","min":9,"max":12}], [{"kind":"tag","op":"is","values":["VIP"]}]. - body `name` (string): Optional label, max 120. - body `is_active` (boolean): Default true. - body `position` (number): 1 = checked first. Default last. - example body: {"workspace_id":"uuid","calendar_id":"uuid","name":"Girls 13-14","conditions":[{"kind":"field","key":"player_group","op":"is","values":["Girls 13-14"]}]} - `PATCH /v1/calendar-routes/{route_id}` — Change a calendar routing rule (scope bookings:write) Send any of calendar_id, name, conditions (replaces the list) and is_active. To move a rule use POST /v1/calendar-routes/reorder. Owners and admins only. - path `route_id` (string, required): Rule id. - body `calendar_id` (string): Another calendar of the sub-account. - body `conditions` (array): Replaces the conditions (see create). - body `name` (string): Max 120. - body `is_active` (boolean): false keeps the rule but skips it. - example body: {"is_active":false} - `DELETE /v1/calendar-routes/{route_id}` — Delete a calendar routing rule (scope bookings:write) Owners and admins only. The other rules keep their order. - path `route_id` (string, required): Rule id. - `POST /v1/calendar-routes/reorder` — Set the order rules are checked in (scope bookings:write) The first rule that matches wins, so put narrower rules first. `order` lists every rule id of the sub-account exactly once, first to last. Answers the rules in their new order. Owners and admins only. - body `order` (array, required): Every rule id, first to last. - example body: {"workspace_id":"uuid","order":["uuid-rule-b","uuid-rule-a"]} - `GET /v1/calendar-routes/match` — Which calendar a lead routes to (scope bookings:read) Runs the rules the way the booking paths do (active rules on calendars that are on) against a lead's custom fields and tags, and/or `answers` you pass. status: matched (`calendar` and the `route` that won), pending (no rule matched yet but one still can: `missing_fields` are the answers to ask for before offering times), unmatched (no rule fits: the form's or the AI's own calendar applies), or no_rules. Viewers limited to their own leads only reach those leads. - query `lead_id` (string): The lead to route. Send lead_id, answers or both. - query `answers` (string): JSON object of field key to answer to try, laid over the lead's own, e.g. {"player_group":"Girls 13-14"}. ### Team busy times - `PUT /v1/busy-blocks/{external_id}` — Add or update a team member's busy block (scope bookings:write) For a schedule kept in other software (a field-service app, a dispatch board): the person is treated as booked for that time, so the AI (text, chat and phone), Smart Forms, booking pages and round robin only offer times when they are free. `external_id` is YOUR id for the block (a job or visit id, URL-encoded in the path); sending the same id again replaces the block, so it is safe to resend. A block can make several people busy (a two-tech job). Team members are named by user id or email (GET /v1/members); technicians must be invited as members first. Times need a time zone (Z or an offset). At most 31 days per block. 201 when created, 200 when replaced (changed: false when nothing differed). Owners and admins of the sub-account only. - path `external_id` (string, required): Your own id for the block: 1-200 letters, digits or . _ : ~ @ # | + = - - body `team_member` (string): The busy person: a team member's user id or email. Or team_members for several. - body `team_members` (array): Several busy people (user ids or emails), up to 50. - body `starts_at` (string, required): ISO 8601 with a zone, e.g. 2026-10-14T08:00:00-05:00. - body `ends_at` (string, required): ISO 8601 with a zone; after starts_at. - body `title` (string): Optional note shown to the team in the CRM calendar (never to leads or the AI), max 200. - example body: {"workspace_id":"uuid","team_member":"tech.alex@example.com","starts_at":"2026-10-14T08:00:00-05:00","ends_at":"2026-10-14T11:30:00-05:00","title":"Job #4821 water heater install"} - `DELETE /v1/busy-blocks/{external_id}` — Remove a busy block (scope bookings:write) By your own id; the time opens up again at once. 404 when there is no block with that id. - path `external_id` (string, required): Your id for the block (URL-encoded). - `GET /v1/busy-blocks` — List busy blocks (scope bookings:read) Blocks that overlap the window, earliest first. Default window: from yesterday, 60 days long; at most 366 days. - query `team_member` (string): Only this person's blocks (user id or email). - query `from` (string): ISO start with a zone. - query `to` (string): ISO end with a zone. - query `limit` (number): 1-500, default 100. - query `offset` (number): Skip this many (has_more says whether there are more). - `POST /v1/busy-blocks/sync` — Sync a time window in one call (scope bookings:write) Send your full list of busy blocks for a window: blocks in the list are added or replaced, and blocks you sent earlier that START inside [from, to) but are no longer in the list are removed (cancelled or moved jobs). With team_member, only that person's blocks are replaced and each block defaults to them; a removed block that also names other people keeps them. Up to 500 blocks per call. Good for a nightly or hourly full sync next to the per-block calls. Owners and admins only. - body `from` (string, required): Window start, ISO 8601 with a zone. - body `to` (string, required): Window end; at most 366 days after from. - body `team_member` (string): Sync one person only (user id or email). - body `blocks` (array, required): [{ external_id, team_member | team_members, starts_at, ends_at, title? }]. [] clears the window. - example body: {"workspace_id":"uuid","from":"2026-10-13T00:00:00-05:00","to":"2026-10-20T00:00:00-05:00","team_member":"tech.alex@example.com","blocks":[{"external_id":"job-4821","starts_at":"2026-10-14T08:00:00-05:00","ends_at":"2026-10-14T11:30:00-05:00"},{"external_id":"pto-2210","starts_at":"2026-10-17T00:00:00-05:00","ends_at":"2026-10-18T00:00:00-05:00","title":"Day off"}]} ### Pipeline & fields - `POST /v1/stages` — Add a pipeline stage (scope leads:write) `behavior` is what the stage means for reporting. The key is made from the label and never changes. - body `label` (string, required): Stage name (max 40). - body `behavior` (string): Default contacted. - body `color` (string): Defaults to the first unused colour. - body `manual_only` (boolean): Moving a lead here does not change its status. - example body: {"workspace_id":"uuid","label":"Quote sent","behavior":"contacted"} - `PATCH /v1/stages/{stage_id}` — Rename, recolour or hide a stage (scope leads:write) The five built-in stages (new, contacted, booked, won, lost) can only change label, color and hidden. - path `stage_id` (string, required): Stage id. - `DELETE /v1/stages/{stage_id}` — Delete a custom stage (scope leads:admin) Its leads move to the stage named in move_to. Built-in stages cannot be deleted; hide them instead. - path `stage_id` (string, required): Stage id. - query `move_to` (string, required): Key of the stage that takes over the leads. - `POST /v1/stages/reorder` — Reorder the pipeline (scope leads:write) - body `order` (array, required): Every stage id of the sub-account, first to last. - `GET /v1/custom-fields` — List custom lead fields (scope leads:read) - query `include_archived` (boolean): Include archived fields. - `POST /v1/custom-fields` — Add a custom lead field (scope leads:write) field_key and field_type cannot change later, because stored lead values depend on them. - body `label` (string, required): Field label (max 80). - body `field_type` (string): Default text. - body `field_key` (string): Defaults to a key made from the label. - body `options` (array): Choices for select / multiselect. - body `required` (boolean): Default false. - body `show_in_list` (boolean): Show as a column in the leads list. - example body: {"workspace_id":"uuid","label":"Roof type","field_type":"select","options":["Shingle","Metal","Tile"]} - `PATCH /v1/custom-fields/{field_id}` — Update a custom field (scope leads:write) Send `archived: false` to restore an archived field. - path `field_id` (string, required): Field id. - `DELETE /v1/custom-fields/{field_id}` — Archive a custom field (scope leads:write) Hides the field. Values already stored on leads are kept. - path `field_id` (string, required): Field id. ### Routing & alerts - `GET /v1/lead-routing` — Get lead round-robin settings (scope workspaces:read) - `PUT /v1/lead-routing` — Set lead round-robin settings (scope workspaces:write) Assigns NEW LEADS to team members in turn. (A round-robin calendar is separate: it rotates appointment hosts.) An empty eligible_member_ids list means everyone takes turns. member_weights splits leads by percentage (80/20 gives one person 8 of every 10 leads, spread out); {} goes back to even turns. - body `round_robin_enabled` (boolean): Turn the rotation on or off. - body `eligible_member_ids` (array): User ids from GET /v1/members. Empty = everyone. - body `member_weights` (object): Percentage split by user id (GET /v1/members): {"": 80, "": 20}. Whole percents 0-100; the shares above 0 must add up to exactly 100. Sets eligible_member_ids to the people with a share and restarts the rotation. {} = even turns (keeps who is in the rotation). - body `notify_assignee_only` (boolean): Alert only the person the lead went to. - body `skip_imported_leads` (boolean): Leave imported leads unassigned. - body `notify_on_reply` (boolean): Alert the assignee when the lead replies. - example body: {"workspace_id":"uuid","round_robin_enabled":true,"member_weights":{"user-uuid-a":80,"user-uuid-b":20}} - `GET /v1/alert-recipients` — List who is alerted about new leads and AI receptionist calls (scope workspaces:read) - `POST /v1/alert-recipients` — Add a lead alert recipient (scope workspaces:admin) Lead details are sent to this phone or inbox, so this needs an admin-scoped key. - body `channel` (string, required): sms or email. - body `destination` (string, required): Phone (US 10-digit or +country code; stored as E.164) or email address. - body `label` (string): e.g. Owner's cell. - body `notify_leads` (boolean): Gets new-lead, appointment and reply alerts. Default true. - body `notify_calls` (boolean): Gets a summary after every AI receptionist call (who called, the outcome, any message or booking, the transcript). Default false. - example body: {"workspace_id":"uuid","channel":"sms","destination":"+14155550123","label":"Owner"} - `PATCH /v1/alert-recipients/{recipient_id}` — Update a lead alert recipient (scope workspaces:admin) Send any of label, destination, active, notify_leads, notify_calls. A recipient keeps at least one of notify_leads or notify_calls. - path `recipient_id` (string, required): Recipient id. - `DELETE /v1/alert-recipients/{recipient_id}` — Remove a lead alert recipient (scope workspaces:admin) - path `recipient_id` (string, required): Recipient id. ### Lead sources & webhooks - `GET /v1/lead-sources` — List lead source links (scope workspaces:write) Each link is a private URL that accepts leads, so reading them takes write scope. Treat the URL as a secret. - `POST /v1/lead-sources` — Create a lead source link (scope workspaces:write) Returns a URL any website form, landing page tool or CRM can POST leads (or appointments) to. - body `name` (string, required): e.g. Website contact form. - body `field_mapping` (object): Their field name to ours: {"Full Name":"full_name","Roof size":"custom:roof_size"}. Targets: full_name, email, phone, address, city, state, zip, inquiry, notes, appointment_* or custom:. A state is saved as its code ("Texas" becomes TX). - body `default_source` (string): Source label stamped on these leads. - body `default_status` (string): Default new. - body `payload_kind` (string): Default auto. update = a form your own team fills in (e.g. during a call): its answers go onto the matching contact (lead_id, phone, then email; added quietly when nobody matches) and nothing is sent: no first text, team alert, Instant Lead Connect call or new-lead automation. - example body: {"workspace_id":"uuid","name":"Website contact form","default_source":"Website","field_mapping":{"Your name":"full_name","Phone number":"phone"}} - `PATCH /v1/lead-sources/{lead_source_id}` — Update a lead source link (scope workspaces:write) Links created by an integration (for example Typeform) are managed there and answer 409. - path `lead_source_id` (string, required): Lead source id. - `DELETE /v1/lead-sources/{lead_source_id}` — Delete a lead source link (scope workspaces:admin) - path `lead_source_id` (string, required): Lead source id. - `GET /v1/outbound-webhooks` — List outbound webhooks (scope workspaces:read) Never returns signing secrets or auth tokens. - `POST /v1/outbound-webhooks` — Create an outbound webhook (scope workspaces:admin) Pushes lead and appointment events to another system (Zapier, Make, a CRM). Lead data leaves the account, so every write needs an admin-scoped key and target_url must be https on a public host. The signing secret is returned once. - body `name` (string, required): e.g. Zapier: new leads. - body `target_url` (string, required): https:// URL that receives the POST. - body `events` (array): Default lead.created and appointment.booked. See the sub-account webhook events list. - body `enabled` (boolean): Default true. - body `preset` (string): Payload flavour. - body `auth_type` (string): Default none. Send auth_token (and auth_header_name or auth_username) with it. Write-only. - example body: {"workspace_id":"uuid","name":"Zapier: new leads","target_url":"https://hooks.zapier.com/hooks/catch/123/abc/","events":["lead.created"],"preset":"zapier"} - `PATCH /v1/outbound-webhooks/{webhook_id}` — Update an outbound webhook (scope workspaces:admin) - path `webhook_id` (string, required): Webhook id. - `DELETE /v1/outbound-webhooks/{webhook_id}` — Delete an outbound webhook (scope workspaces:admin) - path `webhook_id` (string, required): Webhook id. ### AI agent - `GET /v1/knowledge-base` — Read the AI's FAQ (scope workspaces:read) - `PUT /v1/knowledge-base` — Replace the AI's FAQ (scope workspaces:write) The FAQ is what the AI texting agent and AI receptionist answer from. Max 200 entries (question 300 characters, answer 2000). - body `entries` (array, required): [{ question, answer }]. Replaces the whole list. - `POST /v1/knowledge-base` — Add FAQ entries (scope workspaces:write) Merges into the existing list. The same question again replaces its answer. - body `entries` (array, required): [{ question, answer }]. - example body: {"workspace_id":"uuid","entries":[{"question":"Do you offer financing?","answer":"Yes, 0% for 12 months on approved credit."}]} - `GET /v1/ai-brain/photos` — AI Brain photos (scope workspaces:read) Photos of the business's work the AI may text a customer who asks to see some (up to 100): link, caption, the service it shows, on / off, how often it was sent. Owners and admins. - query `active` (boolean): Only on (true) or off (false). - `POST /v1/ai-brain/photos` — Add an AI Brain photo (scope workspaces:write) From a public link to a JPEG, PNG or WebP (10 MB at most), stored like an upload on the page. The AI writes the caption and service you leave out, which is how it picks the right photo. 409 at 100 photos. - body `image_url` (string, required): Public link to the image. - body `caption` (string): What it shows (max 300). - body `service` (string): The service (max 80), e.g. Roof repair. - body `active` (boolean): Default true. - example body: {"workspace_id":"uuid","image_url":"https://example.com/jobs/roof-after.jpg","service":"Roof repair"} - `PATCH /v1/ai-brain/photos/{photo_id}` — Change an AI Brain photo (scope workspaces:write) - path `photo_id` (string, required): Photo id. - body `caption` (string): What it shows (max 300). - body `service` (string): The service it shows (max 80). - body `active` (boolean): Off: the AI stops sending it. - `DELETE /v1/ai-brain/photos/{photo_id}` — Remove an AI Brain photo (scope workspaces:write) - path `photo_id` (string, required): Photo id. - `GET /v1/ai-brain/waiting` — Questions waiting on you (scope workspaces:read) AI Brain > Waiting on you: questions customers asked (texts, chat, DMs, calls) that the AI couldn't answer and handed to the team, newest first, one row per question (times = how many customers asked, variants = how they wrote it). Answered and dismissed ones are left out. Owners and admins. - `POST /v1/ai-brain/waiting/answer` — Answer a waiting question (scope workspaces:write) As Answer it on the page: the answer becomes a saved answer (replacing one to the same question) that the AI texter and receptionist use from now on, the question leaves the list, and the AI turns back on for the leads it was paused on for that question. Nothing is sent to the customer. - body `question` (string, required): The question as listed. - body `answer` (string, required): What the AI should say (max 2000). - body `event_id` (string): The row's event_id. - example body: {"workspace_id":"uuid","event_id":"uuid","question":"Do you work on Sundays?","answer":"No, we're open Monday to Saturday, 8 to 6."} - `POST /v1/ai-brain/waiting/dismiss` — Dismiss waiting questions (scope workspaces:write) Takes questions off the list without teaching the AI (it still treats them as open); undo: true puts them back. - body `event_ids` (array): The rows' event_ids. - body `questions` (array): Or the questions themselves. - body `undo` (boolean): Put them back. - `GET /v1/ai-receptionist` — Read the AI receptionist settings (scope workspaces:read) Also returns the list of voices, and collect_fields as a list of keys. - `PUT /v1/ai-receptionist` — Configure the AI receptionist (scope workspaces:write) The AI that answers the sub-account's phone. Answered calls bill 1.5 credits per minute of AI conversation (15-second steps; time after a transfer to a person bills as phone minutes), and it needs a phone number on the sub-account to do anything (the response carries a warning when there is none). - body `enabled` (boolean): Turn it on or off. - body `mode` (string): Every call, or only outside business hours. - body `goal` (string): What it tries to do. - body `agent_name` (string): Max 40. - body `voice` (string): One of the voices returned by GET. - body `greeting` (string): Max 400. - body `after_hours_greeting` (string): Max 400. - body `extra_instructions` (string): Max 1200. - body `transfer_enabled` (boolean): Allow transfers to a person. - body `transfer_numbers` (array): Up to 8 phone numbers. - body `take_messages` (boolean): Take a message when nobody is available. - body `max_call_seconds` (number): 60-1800. - body `record_calls` (boolean): Record answered calls (billed per recorded minute). - body `update_contact_details` (boolean): Let it save the caller's name, email and address to the lead. - body `collect_fields` (array): Details it asks for before booking: "address", "email" or custom field keys (GET /v1/custom-fields). Max 12. - example body: {"workspace_id":"uuid","enabled":true,"mode":"after_hours","goal":"book_and_support","agent_name":"Ava","collect_fields":["address","roof_type"]} ### Smart forms - `POST /v1/smart-forms` — Create a smart form (scope smart_forms:write) Starts unpublished with the same defaults as a form created in the app. The response includes its public path (/f/), qualifier_questions, custom_fields, qualification, calendar_routing, service_area and estimate. Questions can ask for photos (field_type file) and put a price on answers (option_prices) for the instant estimate: switched on with estimate, the answers' prices add up to a live total in the form's footer, saved on the lead with its total as the deal value. Qualification routes each lead to Qualified, Nurture or Not eligible: yes/no qualifier_questions (asked first when qualifier_enabled is on) and choice questions with disqualify_options or nurture_options. A service area (fields.address.service_area) only accepts addresses in chosen US states or within a radius: address suggestions stay inside it and an out-of-area visitor sees your message and cannot send the form; switching it on shows and requires the address, like the builder. Design and tracking pixels are edited in the app. - body `name` (string, required): Form name (max 80). - body `headline` (string): Max 160. - body `subheadline` (string): Max 300. - body `primary_color` (string): #rrggbb. - body `bullet_points` (array): Up to 8 short lines. - body `layout_mode` (string): The builder's Layout: single_step (one page, the default), multi_step (a step-by-step wizard), conversational (one question at a time, like a chat) or funnel (one big question per screen). - body `calendar_id` (string): Calendar used by the booking step. - body `calendar_routing` (boolean): Pick the calendar from the answers: the sub-account's calendar routing rules (/v1/calendar-routes) choose which calendar's times the form shows once the deciding question is answered; calendar_id is used when no rule fits. - body `booking_enabled` (boolean): Show the booking step. - body `fields` (object): Contact fields: {"email":{"required":false},"address":{"enabled":false}}. Keys: first_name, last_name, phone, email, address, state (a State / Province pick list), notes. Phone or email must stay on. address also takes service_area (merged): {"enabled":true,"mode":"states","states":["TX","OK"],"message":"Sorry, we only serve Texas and Oklahoma."}, or mode "radius" with "center":{"lat":32.7767,"lng":-96.797,"label":"Dallas, TX"} and "radius_miles" (1-500, default 25). A blank message shows "Sorry, we don't service this area yet."; null or enabled:false switches it off. - body `is_published` (boolean): Default false. - body `qualifier_enabled` (boolean): Ask the qualifier_questions first. - body `qualifier_questions` (array): Up to 10, replaces the list: [{ text (max 200), disqualify_on: "yes" | "no" (default "no"), outcome: "not_eligible" | "nurture" (default "not_eligible") }]. - body `questions` (array): Custom questions, up to 30, replaces the list: [{ key?, label (max 160), field_type: text | textarea | number | money | phone | email | url | select | multiselect | boolean | date | datetime | rating | file (photos or PDFs, up to 6, shown on the lead), options (select / multiselect: 2-40), option_prices? (select / multiselect: cents per answer for the instant estimate, e.g. {"SUV": 8000}; left out keeps the saved prices, null removes them), disqualify_options? or nurture_options? (choice types; boolean answers "yes" / "no"; never both), placement?: "qualify" | "details" (qualify = choice types only), option_style?: dropdown | buttons | cards | auto, no_first? (boolean: show No before Yes), required?, enabled?, save_to_crm? (never for file), placeholder?, helper_text? }]. - body `qualification` (object): Merged: { save_not_eligible: boolean, nurture_page: { headline, subheadline, cta_label, cta_url, redirect_url } }. - body `estimate` (object): The instant price estimate, merged: { enabled, label (default "Your estimate"), base_cents (added before any answer), note (e.g. "Final price after we see the job"), range_percent (0-50: shown as a range that far either side) }. null switches it off. - example body: {"workspace_id":"uuid","name":"Roof quote","qualifier_enabled":true,"qualifier_questions":[{"text":"Do you own the home?","disqualify_on":"no","outcome":"not_eligible"}],"questions":[{"label":"When do you want to start?","field_type":"select","options":["This month","In 1-3 months","Just researching"],"nurture_options":["Just researching"],"placement":"qualify"},{"label":"Vehicle size","field_type":"select","options":["Car","SUV","Truck"],"option_prices":{"Car":31500,"SUV":38500,"Truck":45000}},{"label":"Photos of the damage","field_type":"file"}],"qualification":{"save_not_eligible":true},"estimate":{"enabled":true,"note":"Final price after we see the job","range_percent":10}} - `PATCH /v1/smart-forms/{form_id}` — Update or publish a smart form (scope smart_forms:write) Takes the same fields as create; send only what changes. questions and qualifier_questions replace their lists; qualification, estimate, fields and fields.address.service_area are merged. - path `form_id` (string, required): Form id. - body `is_published` (boolean): Publish or unpublish. - body `layout_mode` (string): single_step, multi_step, conversational or funnel (see create). - body `qualifier_enabled` (boolean): Ask the qualifier_questions first. - body `qualifier_questions` (array): Replaces the list (see create). - body `questions` (array): Replaces the list (see create). - body `qualification` (object): Merged (see create). - body `estimate` (object): Merged (see create). - body `calendar_routing` (boolean): Pick the calendar from the answers (see create). - body `fields` (object): Merged, including address.service_area (see create). - example body: {"fields":{"address":{"service_area":{"enabled":true,"mode":"radius","center":{"lat":32.7767,"lng":-96.797,"label":"Dallas, TX"},"radius_miles":50}}}} ### AI agent - `GET /v1/ai-texting` — Read the AI texting agent and automatic text settings (scope workspaces:read) AI replies, agent name, reply mode, goal, what it knows, booking link, first text, send window, hand-off, confirmation and reminder texts, missed-call text-back, email greeting, and a preview of its prompt. Says whether the sub-account has a phone number. - `PATCH /v1/ai-texting` — Change the AI texting agent and automatic texts (scope workspaces:write) Send only the settings to change, by these names: ai_replies, agent_name, reply_mode (auto | suggest), goal (book_appointment | collect_details | customer_support), business_context, booking_link, max_replies (1-15), reply_delay_minutes (1-120), ai_can_cancel, handoff_when_unsure, pause_ai_on_handoff, handoff_resume_days (0, 1, 2, 3, 7), greet_new_leads, first_message, smart_first_text (the AI writes each new lead's first text from their answers and the right calendar's open times; first_message becomes the backup), smart_first_text_goal (what that text should get them to do; empty = book an appointment), greet_delay_minutes, form_greet_delay_minutes, missed_call_text, missed_call_message, confirmation_text, confirmation_message, confirmation_email (the confirmation email with a calendar invite, plus the move and cancel emails), confirmation_email_language (en | es), reminder_24h, reminder_24h_message, reminder_1h, reminder_1h_message, reminder_5m (the 5-minute reminder, off by default), reminder_5m_message, email_greeting, email_greeting_subject, email_greeting_body, send_window (anytime | daily | booking_hours), send_window_start, send_window_end ("HH:MM"), ai_answers_email, prompt_addition (one more rule) or prompt (a full rewrite). Owners, agency admins and client admins can change these. Turning AI replies on lets it answer conversations still waiting for a reply. - body `ai_replies` (boolean): The AI answers leads by text. - body `agent_name` (string): First name the AI texts as (max 40). - body `reply_mode` (string): suggest = drafts each reply for a teammate to approve (GET /v1/reply-suggestions). - body `first_message` (string): First text to a new lead. Variables {first_name}, {agent}, {business}, {service}. - body `send_window` (string): When automated texts may go out. - body `prompt_addition` (string): A rule added to the end of the AI's prompt (max 2000). - example body: {"workspace_id":"uuid","ai_replies":true,"agent_name":"Sarah","reply_mode":"auto","prompt_addition":"Always mention free estimates."} - `GET /v1/nurture-sequence` — Read the automatic follow-up sequence (scope workspaces:read) Every text and email step with the day it goes out, whether each channel is on, and offers whose own follow-ups replace it for the leads they match. - `PUT /v1/nurture-sequence` — Replace the follow-up texts (or emails) (scope workspaces:write) Replaces one channel's steps and turns it on. Timing is the app's: the first 3 hours after the first text, then front-loaded days over span_days (about 5 days per message, at most 60), or the explicit days you send. At most 40 texts or 60 emails; email needs a verified sending domain. Pending sends that would change channel are cancelled. - body `channel` (string): Default sms. - body `messages` (array, required): One message per step, in order. - body `subjects` (array): Email only: one subject per message. - body `span_days` (number): Days from the first message to the last (1-365). - body `days` (array): Instead of span_days: the day each message goes out, going up. 0 = 3 hours in. - body `enabled` (boolean): Default true. - example body: {"workspace_id":"uuid","channel":"sms","messages":["Hi {first_name}, still looking for a quote?","Quick check-in from {business}: want me to hold a time for you?"],"span_days":7} - `PATCH /v1/nurture-sequence` — Switch follow-ups on or off, or reword one step (scope workspaces:write) Send enabled, or step with message (and subject for email). A reworded step keeps its timing. - body `channel` (string): Default sms. - body `enabled` (boolean): On or off. - body `step` (number): Which step to reword (1 = first). - body `message` (string): The step's new wording. - body `subject` (string): Email only: the new subject. - example body: {"workspace_id":"uuid","channel":"sms","step":2,"message":"Hi {first_name}, any questions I can answer?"} - `DELETE /v1/nurture-sequence` — Remove one channel's follow-up steps (scope workspaces:write) Switches that channel off and cancels its pending sends. - query `channel` (string): Default sms. ### Setup - `GET /v1/business-profile` — Read the business profile (scope workspaces:read) Name, industry, time zone, address, country, business phone and business email (Settings → General). - `PATCH /v1/business-profile` — Change the business profile (scope workspaces:write) Send only what changes. A new time zone also moves the booking hours' time zone, as in the app. - body `name` (string): Max 120. - body `industry` (string): Max 80. - body `timezone` (string): IANA zone, e.g. America/Chicago. - body `address_line1` (string): Street. - body `address_line2` (string): Suite, unit. - body `city` (string): City. - body `state` (string): State or region. - body `postal_code` (string): ZIP or postal code. - body `country` (string): Two-letter country code (US, CA, GB, AU; "United States" works too), or null. It picks the State list on leads, forms and booking pages, and the list a lead's state is matched against when the lead has no phone. - body `business_phone` (string): US 10-digit or + and a country code. - body `business_email` (string): Email address. - example body: {"workspace_id":"uuid","timezone":"America/Chicago","country":"US","business_phone":"+14155550123"} ### Dashboard - `GET /v1/overview` — Dashboard numbers for a window (scope workspaces:read) New leads, booked leads and appointments (each with the previous window of the same length for comparison), upcoming appointments, contacted, won and closed, speed to lead (median minutes to the first reply: anyone, AI or automation, a person), AI replies sent, calls (answered, missed, voicemails, AI calls, talk time), and stage_reach: of the leads created in the window, how many reached each pipeline stage (`total`, and `reached` keyed by stage key from GET /v1/stages; a lead counts for every stage it has been in, so a lead that sat and then won counts for both; the Overview's " rate" cards divide reached by total). Moves made before 2026-10-16 are not known. stage_reach is null if it could not be read. Viewers limited to their own leads see only those. - query `days` (number): 1-365, default 30. - query `from` (string): ISO start, instead of days (window at most 366 days). - query `to` (string): ISO end, default now. - `GET /v1/health-score` — A sub-account's health score (scope workspaces:read) The 0-100 health score from the Sub-accounts list and its breakdown: grade (Excellent, Healthy, Needs attention, At risk, Dormant), the five factors (activity recency 15, lead flow 20, speed to lead 25, leads answered 15, booking rate 25) with the points each earned, its value and how it was worked out; a factor that can't be measured yet has earned null (listed in not_measured) and its weight is spread over the rest. verdict says what goes well and what holds it back; actions is what would raise it, biggest gain first (gain in score points; path is the page inside the sub-account, e.g. settings?tab=messaging), with people waiting for a reply first. history is the score at the end of each of the last weeks (oldest first, the last one now), and last_30_days the funnel, reply speed and lead sources behind it. Leads leave out spam and imported lists. Any member; Technicians and Viewers limited to their own leads are scored on those. - query `weeks` (number): Weeks of history, 1-26, default 12. - `GET /v1/health-scores` — Health scores of every sub-account (scope workspaces:read) Every sub-account the key's person can open, best first, scored as GET /v1/health-score scores them: score, grade, rank among the active ones (null for a sub-account where nothing has happened yet), the factor holding it back most (held_back_by, when it costs 3 points or more), each factor's points and the inputs; plus the median score and the medians of each input across the active ones. A key restricted to one sub-account gets just that one. Archived sub-accounts are left out unless include_archived=true. - query `include_archived` (boolean): Also archived sub-accounts. - `GET /v1/usage` — Credits used by tool (scope billing:read) What the sub-account spent in a window, by tool (the Usage tab's names: texts, lead alert texts, email, AI text replies, website chat widget, AI agents, phone calls, AI receptionist, AI calling, phone numbers, ad tools) and by day. unpaid counts events that ran while the account was out of credits. - query `days` (number): 1-365, default 30. - query `from` (string): ISO start, instead of days. - query `to` (string): ISO end, default now. ### Inbox - `GET /v1/conversations` — The Inbox: conversations, newest first (scope messaging:read) Every lead with a message either way (or an unread one), like the Inbox: unread count, archive state, whether the AI is paused on it (and the question it handed to the team), and the last message or call. The first page also returns the Inbox counts. Read the thread with GET /v1/leads/{lead_id}/conversation. - query `archived` (boolean): true = the Archived tab. Default false. - query `unread` (boolean): Only unread conversations. - query `assigned_to` (string): A user id, "me" or "unassigned". - query `search` (string): Name, email or phone contains (2-80 characters). - query `imessage_line_id` (string): Only the conversations this iMessage Mac has had (GET /v1/imessage/lines), like the Inbox's number filter. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `POST /v1/conversations/{lead_id}/read` — Mark a conversation read (scope messaging:write) Anyone who can see the lead can, as in the Inbox. - path `lead_id` (string, required): Lead id. - `POST /v1/conversations/{lead_id}/unread` — Mark a conversation unread (scope messaging:write) - path `lead_id` (string, required): Lead id. - `POST /v1/conversations/{lead_id}/archive` — Archive a conversation (scope messaging:write) As in the app, archiving switches the lead's automatic follow-up texts off. A new message from the lead brings the conversation back. - path `lead_id` (string, required): Lead id. - `POST /v1/conversations/{lead_id}/unarchive` — Move a conversation back to the Inbox (scope messaging:write) Follow-ups switched off by archiving stay off. - path `lead_id` (string, required): Lead id. - `POST /v1/leads/{lead_id}/ai-pause` — Pause or resume the AI on one lead (scope messaging:write) paused: true stops AI replies to this lead (and its automatic follow-ups at send time) until someone turns it back on, or until `until`. paused: false turns it back on and clears any hand-off. The sub-account-wide switch is ai_replies on PATCH /v1/ai-texting. - path `lead_id` (string, required): Lead id. - body `paused` (boolean, required): Pause (true) or resume (false). - body `until` (string): ISO time the AI turns itself back on (paused: true only, at most a year away). - example body: {"paused":true,"until":"2026-10-07T15:00:00Z"} - `GET /v1/reply-suggestions` — AI suggested replies waiting for a teammate (scope messaging:read) When AI texting's reply_mode is suggest, the AI drafts its reply to each text or email here instead of sending it. Each one shows the lead, the draft, and the appointment it would book or cancel. reply_mode in the response says whether the sub-account is in suggest mode. - query `status` (string): Default pending. - query `lead_id` (string): One lead's suggestions. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `POST /v1/reply-suggestions/{suggestion_id}/dismiss` — Dismiss a suggested reply (scope messaging:write) Nothing is sent. The AI does not suggest again until the lead writes. 409 when it was already handled. - path `suggestion_id` (string, required): Suggestion id. - `POST /v1/reply-suggestions/{suggestion_id}/approve` — Send a suggested reply (scope messaging:write; uses credits) Sends it to the lead as the AI (edited, if you send body), makes the booking or cancellation it decided on, and is charged exactly like an automatic AI reply plus the text, through the same code as the Inbox's Send button. Owners and admins only. 409 = someone already answered or the lead wrote again (nothing sent), 422 = not sent for a reason in `error` (e.g. AI paused, out of credits, that time is no longer open), 503 = a sending hiccup, try again. - path `suggestion_id` (string, required): Suggestion id. - body `body` (string): The edited reply to send instead (texts up to 1600 characters, emails 5000). - example body: {"body":"Thursday at 2pm works! See you then."} - `POST /v1/leads/{lead_id}/reply-ideas` — Reply ideas for a conversation (scope messaging:write) The Inbox composer's reply assistant: up to three ready replies in the business's tone (Settings > Reply assistant), written from the conversation, calls, appointments, the lead's stage and the AI Brain. `kind` says what they are: reply (an answer to their message), follow_up (a nudge after the business's own message) or first (the first message). Send `draft` to polish your own text instead (`how`: improve, grammar, shorter, a tone, or custom with `instruction`); the answer is `text`. Nothing is sent or saved: send the one you pick with POST /v1/messages. Free, and counted in the person's hourly allowance shared with the Inbox (429 when it's used up). Anyone who can see the lead. - path `lead_id` (string, required): Lead id. - body `channel` (string): Where the reply goes. Default sms. - body `tone` (string): New ideas only: this tone instead of the business's own. - body `avoid` (array): New ideas only: up to 6 replies you already have, to get different ones. - body `draft` (string): Polish this text instead (max 4000). - body `how` (string): With draft. Default improve. - body `instruction` (string): With how custom: what to change (max 300). - example body: {"channel":"sms"} - `GET /v1/needs-reply` — Who is waiting on a person (Needs you now) (scope messaging:read) The CRM overview's "Needs you now": everyone from the last 14 days waiting on someone at the business, newest first, and why. `ai_handoff`: the AI told them the team would get back to them and nobody has written, called or booked them since (`question` is what it couldn't answer, `asked_again` when they chased it). `missed_call`: they called and nobody picked up or called back (`voicemail`, `message_taken` by the AI receptionist, `call_note`). `message`: their message has no reply from a person or the AI (reminders, follow-ups and automations aren't replies; a thanks or ok after a message that asked nothing needs none; with AI replies on, a brand-new message is the AI's for its first 3 minutes). `total`, `by_reason` and `longest_since` count everyone; `leads` lists up to `limit`. Technicians and limited Staff see only their own leads. - query `limit` (number): How many people to list, 1-100, default 25. ### Calls - `GET /v1/calls` — Phone calls, newest first (scope messaging:read) Every call on the sub-account's numbers: direction, type (softphone, bridge, inbound, forward, ai, ai_receptionist), status, duration, voicemail, the AI's outcome and summary, and the lead. Get one for its transcript and recording. - query `direction` (string): Inbound or outbound. - query `type` (string): Call type. - query `outcome` (string): The Calls tab's outcome filter. - query `lead_id` (string): One lead's calls. - query `since` (string): ISO time, calls at or after. - query `until` (string): ISO time, calls before. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/calls/{call_id}` — One call: summary, transcript and recording (scope messaging:read) recording.url is a fresh link that works for 15 minutes; ask again for a new one. - path `call_id` (string, required): Call id. - `GET /v1/call-campaigns` — AI calling campaigns and their progress (scope messaging:read) Leads, calls placed and connected, bookings, and credits used against the spend cap. Owners and admins only. - query `status` (string): Only this status. - `POST /v1/call-campaigns/{campaign_id}/pause` — Pause a running AI calling campaign (scope messaging:write) Its queued calls are cancelled. Resuming places paid calls, so it is done in the app. 409 when it is not running. - path `campaign_id` (string, required): Campaign id. ### AI Brain - `GET /v1/ai-lessons` — What the team has taught the AI (scope workspaces:read) Settings → AI Brain: rules (instructions every AI reply follows), good examples (thumbs up) and lessons (thumbs down: what was wrong, a better reply, never send anything like it again). The AI texter and the voice agent read the active ones on every reply. Owners and admins only. - query `kind` (string): Only this kind. - query `active` (boolean): Only switched on (true) or off (false). - query `limit` (number): 1-100, default 50. - query `cursor` (string): next_cursor from the previous page. - `POST /v1/ai-lessons` — Add a rule the AI follows (scope workspaces:write) Like Add rule in Settings → AI Brain. channel limits it to texts (sms), email or calls (voice); leave it out for everywhere. To teach from a specific reply, rate it (POST /v1/messages/{message_id}/rating). Owners and admins only; at most 200 rules. - body `note` (string, required): The rule, max 600 characters. - body `channel` (string): Where it applies. Default everywhere. - body `active` (boolean): Default true. - example body: {"workspace_id":"uuid","note":"Never quote prices by text; offer a free estimate visit instead.","channel":"sms"} - `PATCH /v1/ai-lessons/{lesson_id}` — Switch a lesson off or reword it (scope workspaces:write) What can change depends on the kind, as in the app: a rule's note, channel and active; a thumbs-down lesson's note, better_reply, never_again and active; a good example's active only. - path `lesson_id` (string, required): Lesson id. - body `active` (boolean): On or off. - body `note` (string): Max 600. - body `channel` (string): Rules only. - body `better_reply` (string): Thumbs-down lessons only, max 2000. - body `never_again` (boolean): Thumbs-down lessons only. - example body: {"active":false} - `DELETE /v1/ai-lessons/{lesson_id}` — Delete a lesson for good (scope workspaces:write) active: false on PATCH keeps it but switches it off. - path `lesson_id` (string, required): Lesson id. - `POST /v1/messages/{message_id}/rating` — Thumbs up or down on an AI message (scope workspaces:write) Exactly the Inbox's rating. up keeps the reply as a good example; down records what was wrong (reasons), what it should have said (better_reply), a note, and by default never to send anything close again; clear removes the rating. Rating the same message again replaces its lesson. Works on messages and calls sent to the lead (message ids from GET /v1/leads/{lead_id}/conversation). Owners and admins only. - path `message_id` (string, required): The message (lead event) id. - body `rating` (string, required): up, down or clear. - body `reasons` (array): down only: wrong_info, too_pushy, too_long, missed_question, wrong_tone, should_not_reply. - body `better_reply` (string): down only: what it should have said (max 2000). - body `note` (string): down only: a note (max 600). - body `never_again` (boolean): down only. Default true. - example body: {"rating":"down","reasons":["too_pushy"],"better_reply":"No rush at all, happy to answer any questions first."} ### Setup - `GET /v1/phone-numbers` — The sub-account's phone numbers (scope phone_numbers:read) Number, name, default, capabilities, texting registration and caller-name status, and who may use it: assigned_user_id (a number that belongs to one team member: it rings only them and other technicians can't text from it), tech_can_answer and tech_can_use (whether it rings technicians and whether they may call and text from it). Buying and releasing numbers is done in the app. iMessage Macs: GET /v1/imessage/lines. - query `include_released` (boolean): Include released numbers. ### Invoices & reviews - `GET /v1/invoices` — Invoices (read only) (scope billing:read) The sub-account's invoices, newest first. effective_status adds overdue (sent and past due), as the app shows it. kind is invoice, deposit (it lists the whole job but asks only for deposit_cents now; deposit_percent when it was a percent) or balance (made by Bill the balance: deposit_invoice_id is the deposit it follows and deposit_applied_cents comes off the job total). total_cents is always what this invoice asks for. Owners and admins only. Payment processor details are never returned. - query `status` (string): Filter. - query `lead_id` (string): One lead's invoices. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/invoices/{invoice_id}` — One invoice with its line items and history (scope billing:read) Adds the customer's address, notes, terms, subtotal, discount and tax, the PDF link, line items, the event history (created, sent, viewed, paid) and public_path, the customer's view-and-pay page on the sub-account's domain (none for drafts). - path `invoice_id` (string, required): Invoice id. - `GET /v1/estimates` — Estimates (read only) (scope billing:read) The sub-account's estimates, newest first, as the Estimates tab lists them: number, title, the customer, status and effective_status (expired: sent and past its last day), when it was sent, viewed, approved (and by whom) or declined (and why), the invoice it became, its Good / Better / Best options with their totals, and total_cents (the option the customer picked, else the recommended one). Technicians and Staff limited to their own leads see the estimates for leads they can see and ones they made without a lead, as in the app. - query `status` (string): Filter. - query `lead_id` (string): One lead's estimates. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/estimates/{estimate_id}` — One estimate with its options, lines and history (scope billing:read) Adds the customer's address, intro, terms, tax rate and the customer's approval note, every option (name, description, photo, recommended, subtotal, tax and total) with its lines (name, details, photo, quantity, unit price, taxable), the history (created, sent, viewed, approved, declined) and public_path, the customer's page on the sub-account's domain (none for drafts). - path `estimate_id` (string, required): Estimate id. - `GET /v1/price-book` — The price book (scope billing:read) The saved items estimates and invoices pick their lines from: name, details, category, unit price, taxable, photo, and how often it's used (most used first). - query `search` (string): Name or category contains (2-80 characters). - query `include_inactive` (boolean): Include archived items. - query `limit` (number): 1-500, default 100. - `POST /v1/estimates` — Create an estimate (draft) (scope billing:write) Saved as a draft exactly as the estimate editor saves one: the sub-account's next number, its default terms, days valid and tax rate, the lead's name, email, phone and address filled in. Send items for one option, or options (2-4, e.g. Good / Better / Best) each with its items; every option's subtotal, tax and total are worked out as the editor does (each line rounded, tax on taxable lines). Answers with the estimate as GET /v1/estimates/{estimate_id} shows it. Send it with POST /v1/estimates/{estimate_id}/send. Technicians only while the sub-account lets them make estimates, and only for their own leads. - body `lead_id` (string): Who it is for (fills in the customer; needed to send it). Or customer_name. - body `title` (string): Max 200, e.g. Whole-house duct cleaning. - body `intro` (string): A note to the customer at the top (max 2000). - body `items` (array): One option's lines: [{ description (the line's name, max 300), details? (max 2000), image_url? (https), quantity? (default 1), unit_price_cents, taxable? (default true) }]. - body `options` (array): Instead of items, up to 4 choices: [{ name, description?, image_url?, recommended?, items: [...] }]. One is recommended (the first marked, else the first). - body `tax_rate` (number): Percent, 0-30. Default: the sub-account's. - body `valid_days` (number): Days it is valid (1-365). Default: the sub-account's. Or expires_at. - body `expires_at` (string): Last day, YYYY-MM-DD, or null for no end. - body `terms` (string): Max 4000. Default: the sub-account's estimate terms. - body `currency` (string): 3 letters, default usd. - body `customer_name` (string): Without a lead, or to change what the lead fills in. - body `customer_email` (string): Customer email. - body `customer_phone` (string): Customer phone. - body `customer_address` (string): Customer address. - example body: {"workspace_id":"uuid","lead_id":"uuid","title":"Duct cleaning","options":[{"name":"Good","items":[{"description":"Main trunk lines","unit_price_cents":29900}]},{"name":"Better","recommended":true,"items":[{"description":"Every vent and return","details":"Up to 20 vents, before and after photos.","unit_price_cents":49900}]}]} - `PATCH /v1/estimates/{estimate_id}` — Change an estimate (scope billing:write) Send only what changes. options (or items) replace every option and line, as the editor saves; a new tax_rate re-totals the options. An approved estimate or one already made into an invoice answers 409: make a new one. - path `estimate_id` (string, required): Estimate id. - body `title` (string): New title. - body `intro` (string): New note at the top. - body `lead_id` (string): Or null. - body `items` (array): Replaces the options with one. - body `options` (array): Replaces the options. - body `tax_rate` (number): Percent, 0-30; re-totals the options. - body `valid_days` (number): Days valid from today (1-365). - body `expires_at` (string): Last day, YYYY-MM-DD, or null. - body `terms` (string): New terms. - body `customer_name` (string): Customer name. - body `customer_email` (string): Customer email. - body `customer_phone` (string): Customer phone. - body `customer_address` (string): Customer address. - example body: {"tax_rate":8.25} - `DELETE /v1/estimates/{estimate_id}` — Delete an estimate (scope billing:write) One that became an invoice stays (409), so the invoice still points at it. - path `estimate_id` (string, required): Estimate id. - `POST /v1/estimates/{estimate_id}/send` — Send an estimate to the lead (scope billing:write) Like the editor's Send: a text and/or an email to the estimate's lead with the link to review and approve it (on the sub-account's own domain when it has one), in the editor's own words unless you send message (it must include {link}). Sent as the key's person, with the usual opt-out, credit and limit checks; each is billed like any text or email. A draft (or a declined or expired one) becomes sent. sent lists each channel and why one didn't go. - path `estimate_id` (string, required): Estimate id. - body `channel` (string): Default both (whichever the lead has). - body `message` (string): Your own wording, with {link}. - body `subject` (string): The email's subject. - example body: {"channel":"sms"} - `POST /v1/estimates/{estimate_id}/convert` — Make the invoice (scope billing:write) Convert to invoice: a draft invoice from the option the customer picked (else the recommended one, or option_id), with its lines, the estimate's tax rate and the sub-account's due days, terms and notes; the estimate becomes converted. Owners and admins (invoices are theirs). Send the invoice from the app. - path `estimate_id` (string, required): Estimate id. - body `option_id` (string): The option to invoice. ### Email marketing - `GET /v1/email-campaigns` — Email campaigns and their results (scope messaging:read) The sub-account's marketing emails, most recently changed first, as Tools > Email Marketing lists them: status (draft, scheduled, sending, sent, failed, canceled), subject, who it goes to, the pace (drip: every emails a batch, minutes between batches; null = all at once), how far it got and the results (delivered, opened, clicked, booked, booked after a click, unsubscribed, bounced). Owners and admins. - query `status` (string): Filter. - query `limit` (number): 1-100, default 25. - `GET /v1/email-campaigns/{campaign_id}` — One email campaign (scope messaging:read) Adds its content (subject, preheader, headline, sections in blocks, the button, signature, design), where the button goes (destination), problems (what still blocks sending; ready_to_send when there are none) and the header pictures' status. - path `campaign_id` (string, required): Campaign id. - `POST /v1/email-campaigns` — Create an email campaign (draft) (scope messaging:write; uses credits) With brief, the AI designs and writes the whole email from one or two sentences, as Write it for me does (it can take a minute or two), and suggests an audience (suggested_audience); pictures: true also makes AI header pictures (0.5 credits each, three a round). Without, a draft from the business's own details and the content you send. The button goes to destination (default: the newest published Smart Page, else a booking form) or button_url. Nothing is sent. Owners and admins. - body `name` (string): Your name for it (max 120). - body `brief` (string): What the email is about: the offer, the deadline, who it's for (4-4000 characters). Not with the content fields. - body `pictures` (boolean): With brief: AI header pictures (spends credits). Default false. - body `destination` (object): Where the button goes: { kind: smart_page | smart_form, id }, { kind: url, url } or { kind: none }. - body `subject` (string): Max 150. - body `preheader` (string): The preview line inboxes show after the subject (max 200). - body `eyebrow` (string): A small label above the headline (max 40). - body `headline` (string): Max 160. - body `greeting` (string): e.g. Hi {first_name}, (max 80). - body `body` (string): The words in markdown (## headings, - bullets, **bold**, [links](https://...)), max 12000. Replaces every section with one text section. - body `blocks` (array): Instead of body, up to 24 sections as GET shows them: text {md}, offer {value, label, was, note, kicker}, image {url}, split {url, title, md}, features / steps {title, items}, quote {text, name, stars}, gallery {images}, banner {text}, faq {items: [{q, a}]}, cards {items}, button {label, url}, divider, html {html} (email-safe HTML). - body `button_label` (string): The main button (max 50). - body `button_url` (string): Where it goes: a full http(s) link. - body `hero_image_url` (string): An https picture at the top, or empty to remove it. - body `hero_image_alt` (string): Its description. - body `signoff` (string): e.g. Talk soon, - body `signer_name` (string): Who signs it. - body `signer_title` (string): Their title. - body `ps` (string): A P.S. under the signature (max 600). - body `design` (string): The look. - body `html` (string): Your own HTML (a whole email, max 250,000 characters): sent as written instead of the designed email, with subject and preheader still applied. Scripts are taken out; {first_name}, {business} and {unsubscribe_link} are filled in, and without an unsubscribe link a footer with the business's address and one is added. Send an empty string to go back to the designed email. - body `audience` (string): Who gets it: everyone with an email address, everyone who hasn't booked, leads in some stages, or leads with any of some tags. - body `stages` (array): audience stages: stage keys (GET /v1/stages). - body `tags` (array): audience tags: tag names or ids (GET /v1/tags). - body `not_booked` (boolean): audience tags: only those who haven't booked. - example body: {"workspace_id":"uuid","brief":"$49 furnace tune-up through November 15, for past customers","design":"fresh"} - `PATCH /v1/email-campaigns/{campaign_id}` — Change a draft (scope messaging:write) Send only what changes, as the builder saves it; brief has the AI rewrite the whole draft instead. A campaign that was sent or scheduled answers 409: duplicate it. - path `campaign_id` (string, required): Campaign id. - body `name` (string): New name. - body `brief` (string): The AI rewrites the draft from this (not with the content fields). - body `pictures` (boolean): With brief: new AI header pictures (spends credits). - body `subject` (string): Max 150. - body `preheader` (string): The preview line inboxes show after the subject (max 200). - body `eyebrow` (string): A small label above the headline (max 40). - body `headline` (string): Max 160. - body `greeting` (string): e.g. Hi {first_name}, (max 80). - body `body` (string): The words in markdown (## headings, - bullets, **bold**, [links](https://...)), max 12000. Replaces every section with one text section. - body `blocks` (array): Instead of body, up to 24 sections as GET shows them: text {md}, offer {value, label, was, note, kicker}, image {url}, split {url, title, md}, features / steps {title, items}, quote {text, name, stars}, gallery {images}, banner {text}, faq {items: [{q, a}]}, cards {items}, button {label, url}, divider, html {html} (email-safe HTML). - body `button_label` (string): The main button (max 50). - body `button_url` (string): Where it goes: a full http(s) link. - body `hero_image_url` (string): An https picture at the top, or empty to remove it. - body `hero_image_alt` (string): Its description. - body `signoff` (string): e.g. Talk soon, - body `signer_name` (string): Who signs it. - body `signer_title` (string): Their title. - body `ps` (string): A P.S. under the signature (max 600). - body `design` (string): The look. - body `html` (string): Your own HTML (a whole email, max 250,000 characters): sent as written instead of the designed email, with subject and preheader still applied. Scripts are taken out; {first_name}, {business} and {unsubscribe_link} are filled in, and without an unsubscribe link a footer with the business's address and one is added. Send an empty string to go back to the designed email. - body `audience` (string): Who gets it: everyone with an email address, everyone who hasn't booked, leads in some stages, or leads with any of some tags. - body `stages` (array): audience stages: stage keys (GET /v1/stages). - body `tags` (array): audience tags: tag names or ids (GET /v1/tags). - body `not_booked` (boolean): audience tags: only those who haven't booked. - example body: {"subject":"Last call: $49 tune-ups end Friday","audience":"not_booked"} - `DELETE /v1/email-campaigns/{campaign_id}` — Delete an email campaign (scope messaging:write) A scheduled or sending one answers 409: stop it first. - path `campaign_id` (string, required): Campaign id. - `POST /v1/email-campaigns/{campaign_id}/send` — Send or schedule a draft (scope messaging:write; uses credits) Emails real people. As the Send button: to the saved audience (or the one you send), now or at schedule_at, all at once or a few at a time (drip). Left out: leads with no email address, who unsubscribed, bounced or marked it spam. Each email costs messaging credits (none through the business's own email server); a send the credits don't cover answers 402 before anything goes out. A draft is sent once: a second call answers 409. recipients is how many it goes to. - path `campaign_id` (string, required): Campaign id. - body `audience` (string): Who gets it: everyone with an email address, everyone who hasn't booked, leads in some stages, or leads with any of some tags. - body `stages` (array): audience stages: stage keys (GET /v1/stages). - body `tags` (array): audience tags: tag names or ids (GET /v1/tags). - body `not_booked` (boolean): audience tags: only those who haven't booked. - body `schedule_at` (string): ISO 8601 with a time zone, 2 minutes to 90 days ahead. Leave out to send now. - body `drip` (object): A few at a time: { every: 1-10000 emails, minutes: 5-43200 between batches }. The whole send must fit in 90 days. - example body: {"audience":"tags","tags":["Past customer"],"schedule_at":"2026-11-03T09:00:00-05:00","drip":{"every":100,"minutes":60}} - `POST /v1/email-campaigns/{campaign_id}/cancel` — Stop a send (scope messaging:write) A scheduled campaign goes back to draft; one that is sending stops (the emails not yet sent are skipped). - path `campaign_id` (string, required): Campaign id. - `POST /v1/email-campaigns/{campaign_id}/send-rest` — Send the rest now (scope messaging:write; uses credits) A campaign going out a few at a time: everyone still waiting gets it now. Emails real people. - path `campaign_id` (string, required): Campaign id. - `POST /v1/email-campaigns/{campaign_id}/duplicate` — Duplicate a campaign (scope messaging:write) A new draft with the same content, audience and pace, to change and send again. - path `campaign_id` (string, required): Campaign id. ### Contracts - `GET /v1/contracts` — Contracts (scope leads:read) The sub-account's contracts, newest first: who signs (lead and recipient), status (draft, sent, signed, declined, voided) and stage as the page shows it (draft, sent, viewed, signed, completed when you countersigned, declined, voided, expired), when it was sent, opened, signed or declined (and why), the onboarding call it booked, and sign_url once it is out of draft. - query `status` (string): Filter. - query `lead_id` (string): One lead's contracts. - query `limit` (number): 1-100, default 25. - query `before` (string): next_before from the previous page. - `GET /v1/contracts/{contract_id}` — One contract (scope leads:read) Adds its text (body_html), the values filled in, the {{blanks}} left and its history (created, sent, resent with the channels, viewed, signed, declined, voided). - path `contract_id` (string, required): Contract id. - `GET /v1/contract-templates` — Contract templates (scope leads:read) The sub-account's templates with their {{blanks}}. Most fill in by themselves on a new contract (client_name, client_email, client_phone, client_address, business_name, date); send values for the rest. - query `include_body` (boolean): Include each template's text (body_html). - `POST /v1/contracts` — Create a contract (draft) (scope leads:write) Saved as a draft, as New contract saves one. From a template (template_id, with values for its blanks; the template's onboarding call setting comes along) or from your own text (body in markdown: # headings, paragraphs, - lists, **bold**, at least 40 characters). The lead's name, email, phone and address, the business's name and today's date fill in by themselves; recipient_* are for a contract without a lead. Nothing is sent: share it with POST /v1/contracts/{contract_id}/link or send it with /send (which needs a lead). - body `lead_id` (string): Who signs. - body `template_id` (string): From this template (GET /v1/contract-templates). Or body. - body `values` (object): { blank: value } for the template's {{blanks}} (up to 2000 characters each). - body `body` (string): Instead of a template: the contract's text in markdown (max 60000). - body `subject` (string): The title (max 200). Default: the template's name, or the text's first line. - body `recipient_name` (string): Without a lead. - body `recipient_email` (string): Without a lead. - body `recipient_phone` (string): Without a lead. - body `expires_in_days` (number): The signing link stops working after this many days (1-365). Default: never. - example body: {"workspace_id":"uuid","lead_id":"uuid","template_id":"uuid","values":{"start_date":"November 3","price":"$1,200"}} - `POST /v1/contracts/{contract_id}/link` — Get the signing link (nothing sent) (scope leads:write) As Copy link: the link to share yourself, with nothing emailed or texted. A draft's link doesn't open, so a draft comes out of draft first (status sent). A voided contract answers 409. - path `contract_id` (string, required): Contract id. - body `allow_blanks` (boolean): Let it go out with {{blanks}} left for the signer to fill on the signing page. Default false: 409 with the blanks. - `POST /v1/contracts/{contract_id}/send` — Send a contract for signature (scope leads:write; uses credits) Emails and / or texts the contract's lead the signing link (in the business's name, from its own email and number, as the key's person; billed like any text or email; opted-out leads aren't sent to), and the message shows in the lead's conversation. A draft or declined contract becomes sent; sending again re-sends the same link. sent_via lists what went, failures why a channel didn't. Signed or voided contracts answer 409; one with no lead too. - path `contract_id` (string, required): Contract id. - body `channel` (string): Default email. - body `note` (string): A short note with the link (max 1000). - body `allow_blanks` (boolean): Let it go out with {{blanks}} left for the signer to fill on the signing page. Default false: 409 with the blanks. - example body: {"channel":"both","note":"Here's the agreement we talked about."} - `POST /v1/contracts/{contract_id}/void` — Void a contract (scope leads:write) As Void on the page: the signing link stops working right away. No undo; signed contracts can't be voided. - path `contract_id` (string, required): Contract id. ### Dashboard - `GET /v1/sales` — The Sales page: won jobs, parts, tips and profit (scope leads:read) Settings > Features > Sales (off until an owner or admin turns it on: 403 feature_off until then). Won jobs in the window by the date they were won, as the Sales page adds them up: what customers paid, parts, tips and profit in total, per technician (deal_sold_by, else whoever the lead is assigned to), per lead source and per tag, plus the jobs themselves. Every group also has plans, monthly_cents (the monthly revenue its new plans add) and expected_cents (what its jobs are expected to bring in, one-time jobs at their amount), and each job its deal_type and plan (Plans & memberships). Record a sale with PATCH /v1/leads/{lead_id}: status won, deal_value_cents, deal_parts_cents, deal_tip_cents, deal_sold_by. Owners and admins only. - query `days` (number): 1-365, default 30. - query `from` (string): ISO start, instead of days. - query `to` (string): ISO end, default now. ### Ads & Google - `GET /v1/ad-insights` — The sub-account's Ad Insights (scope meta:read) Exactly what its Ad Insights page shows: spend, leads, cost per lead, impressions and clicks for the Meta ad accounts attached to it (one, or all of them added up with each account's share in accounts, and an error for one that couldn't be read), each read with whichever connected Facebook profile can; per campaign and per ad, only the campaigns and ads the agency picked for this sub-account; ads left out (ads_hidden) when the agency hides them from the client. Amounts are added up in each account's own currency (accounts_meta). 403 ad_insights_off when Ad Insights is off for it. - query `ad_account_id` (string): "all" (default) or one attached account, act_123. - query `date_preset` (string): Default last_30d. - query `since` (string): YYYY-MM-DD, with until (instead of date_preset). - query `until` (string): YYYY-MM-DD. - query `campaign_id` (string): Only this campaign's ads. - `GET /v1/google-ads` — Google Ads: the connection and conversions sent (scope meta:read) The sub-account's own Google Ads connection (Ad Insights > Google Ads): its ad accounts (customers), the one in use, whether booked / won leads are sent back as conversions and to which conversion actions, and the newest conversions with their status (pending, sent, failed, skipped) and how each lead was matched (gclid, gbraid, wbraid or email / phone). Owners and admins. - `GET /v1/google-ads/report` — Google Ads reports, live (scope meta:read) One of the Google Ads screens, read live from Google for one of the sub-account's ad accounts: overview (campaigns with spend, clicks, conversions, totals and by day), ad_groups, keywords, ads, search_terms, negatives, campaign_settings (campaign_id), conversion_actions, bidding, recommendations. Nothing is changed. Owners and admins. - query `report` (string): Default overview. - query `range` (string): Default last_30d. - query `customer_id` (string): One of its accounts (GET /v1/google-ads). Default: the one picked in the app. - query `campaign_id` (string): Narrow to one campaign. - query `ad_group_id` (string): Narrow to one ad group. - query `limit` (number): search_terms: rows, default 500. - `GET /v1/google-business/profiles` — Google Business Profiles (scope workspaces:read) Every Business Profile connected to the sub-account (it can have several): the location, rating, review count, whether Google's API answers for it, and its auto-reply, auto-post and photo settings; plus the Google logins connected (email only). Owners and admins. - `GET /v1/google-business/reviews` — Google reviews and replies (scope workspaces:read) Reviews synced from Google every 15 minutes, newest first, with the reply sent, the draft waiting for approval and its status. Owners and admins. - query `profile_id` (string): One profile. - query `status` (string): Filter. - query `unanswered` (boolean): Only reviews without a reply. - query `max_stars` (number): This many stars or fewer. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/google-business/posts` — Google Business Profile posts (scope workspaces:read) Drafts, scheduled and published posts (title, text, button, offer, photo, when, the live link). Owners and admins. - query `profile_id` (string): One profile. - query `status` (string): Filter. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/google-business/optimizer` — Profile Optimizer runs (scope workspaces:read) Each Profile Optimizer check, newest first: the score, what it found, the keywords, its suggestions and the changes made from it (and undone). Owners and admins. - query `profile_id` (string): One profile. - query `limit` (number): 1-25, default 5. - `GET /v1/map-rankings` — Map Rankings: keywords and scans (scope workspaces:read) Where the business ranks on Google Maps across a grid around it: the keywords tracked (grid, schedule, next and last scan) and the scans, newest first, each with its summary (points, found, top 3, average rank). Owners and admins. - query `keyword_id` (string): One keyword's scans. - query `profile_id` (string): One profile. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/map-rankings/scans/{scan_id}` — One Map Rankings scan (scope workspaces:read) Every grid point with its rank (null: not in the top 20), the competitors found, and the next steps to rank #1 once they've been written (they are written when the scan is first opened in the app). Owners and admins. - path `scan_id` (string, required): Scan id. - `GET /v1/listings` — Business Listings (scope workspaces:read) The directories the business is being listed on: each one's status (queued, scanning, listed, mismatch, not_listed, working, needs_you, submitted, live, owner, skipped, failed) with counts, what differs or what's needed from the owner, the listing link, and the latest activity. Passwords and verification codes are never returned. Owners and admins. - `POST /v1/google-business/posts` — Create a Google post (scope workspaces:write) A post in your own words, Google's rules checked first. Saved as a draft waiting for an OK, or approved at once with approve: true (it then goes up publicly on the business's Google profile on scheduled_for, on its own when the profile is connected to Google; otherwise the app shows it to copy). Owners and admins. - body `profile_id` (string): One of its profiles (default its first). - body `kind` (string): STANDARD (an update, default), OFFER or EVENT. - body `title` (string): OFFER and EVENT posts: up to 58 characters. - body `body` (string, required): The post, up to 1,500 characters. Google refuses a phone number in the text: use the CALL button. - body `cta_type` (string): The button (not on OFFER posts). Left out: the profile's own button and link. - body `cta_url` (string): Full https:// link for the button (or an offer's link). - body `coupon_code` (string): OFFER: the code, up to 58 characters. - body `offer_terms` (string): OFFER: terms and conditions. - body `starts_at` (string): EVENT: when it starts, ISO date-time. - body `ends_at` (string): EVENT: when it ends; OFFER: when it ends (default 30 days). ISO. - body `image_url` (string): A public link to a JPG or PNG (5 MB, 250 x 250 at least), copied in like an upload. - body `scheduled_for` (string): When it goes up on Google, ISO date-time (default: the next posting day on the profile's schedule). - body `approve` (boolean): true: approved now (scheduled), as the app's Schedule it. Default false (a draft). - example body: {"workspace_id":"uuid","body":"Spring tune-ups are open: book a visit and we'll check your whole system in under an hour.","cta_type":"BOOK","cta_url":"https://acmehvac.com/book"} - `POST /v1/google-business/posts/write` — Have the AI write Google posts (scope workspaces:write) The AI writes 1-8 posts in the business's voice from an idea, or one post about each photo of the work in photo_urls (the post carries that photo), dated on the profile's posting days. They are saved as drafts: nothing goes to Google until one is approved or published. Owners and admins. - body `profile_id` (string): One of its profiles (default its first). - body `idea` (string): What to write about, up to 600 characters (needed for OFFER and EVENT). - body `kind` (string): STANDARD (an update, default), OFFER or EVENT. - body `count` (number): 1-8, default 4 (with photo_urls: one per photo). - body `photo_urls` (array): Up to 8 public JPG or PNG links of the business's work. - body `cta_type` (string): The button (not on OFFER posts). Left out: the profile's own button and link. - body `cta_url` (string): Full https:// link for the button (or an offer's link). - body `starts_at` (string): EVENT: when it starts, ISO date-time. - body `ends_at` (string): EVENT: when it ends; OFFER: when it ends (default 30 days). ISO. - body `scheduled_for` (string): The date of a single post, ISO. - example body: {"workspace_id":"uuid","idea":"Free furnace check with any tune-up this month","count":2} - `PATCH /v1/google-business/posts/{post_id}` — Edit a Google post (scope workspaces:write) Change a post that isn't on Google yet (draft, scheduled or failed): send only what changes; image_url null removes the photo. Google's rules are checked on the result. A scheduled post stays approved for its new date. Owners and admins. - path `post_id` (string, required): Post id (GET /v1/google-business/posts). - body `title` (string): OFFER and EVENT posts: up to 58 characters. - body `body` (string): The post, up to 1,500 characters. Google refuses a phone number in the text: use the CALL button. - body `cta_type` (string): The button (not on OFFER posts). Left out: the profile's own button and link. - body `cta_url` (string): Full https:// link for the button (or an offer's link). - body `coupon_code` (string): OFFER: the code, up to 58 characters. - body `offer_terms` (string): OFFER: terms and conditions. - body `starts_at` (string): EVENT: when it starts, ISO date-time. - body `ends_at` (string): EVENT: when it ends; OFFER: when it ends (default 30 days). ISO. - body `scheduled_for` (string): When it goes up on Google, ISO date-time (default: the next posting day on the profile's schedule). - body `image_url` (string): A public JPG or PNG link, or null to remove the photo. - example body: {"body":"Spring tune-ups are open this week only.","scheduled_for":"2026-11-04T17:00:00Z"} - `POST /v1/google-business/posts/{post_id}/approve` — Approve a Google post (scope workspaces:write) A draft becomes scheduled: it goes up publicly on the business's Google profile on its date (on its own when the profile is connected to Google). Google's rules are checked first and the date must not have passed (send scheduled_for to move it). Owners and admins. - path `post_id` (string, required): Post id. - body `scheduled_for` (string): A new date, ISO (default the post's own). - `POST /v1/google-business/posts/{post_id}/unschedule` — Unschedule a Google post (scope workspaces:write) A scheduled post goes back to the drafts, so it doesn't go up on its date. Owners and admins. - path `post_id` (string, required): Post id. - `POST /v1/google-business/posts/{post_id}/publish` — Post on Google now (scope workspaces:write) Publishes the post publicly on the business's Google profile right away, as the app's Post now (a draft, scheduled or failed post). It needs the profile connected to Google; Google's rules are checked first. When Google doesn't take it the answer is 409 with details.code: awaiting_google (Google hasn't opened its API to the account yet) or not_posted (the reason is in error and on the post). Owners and admins. - path `post_id` (string, required): Post id. - `DELETE /v1/google-business/posts/{post_id}` — Delete a Google post (scope workspaces:write) Removes the post from the app. A post already published stays on Google (still_on_google: true); remove it there. Not while it is going up. Owners and admins. - path `post_id` (string, required): Post id. - `POST /v1/google-business/reviews/{review_id}/draft` — Have the AI draft a review reply (scope workspaces:write) The AI writes the reply in the business's voice and tone (the tool's reply settings), or rewrites it following instruction, and saves it as the review's draft. Nothing is posted. Owners and admins. - path `review_id` (string, required): Review id (GET /v1/google-business/reviews). - body `instruction` (string): How to write or change it, up to 600 characters (e.g. mention the warranty). - `PATCH /v1/google-business/reviews/{review_id}` — Edit a reply draft, or skip a review (scope workspaces:write) draft_reply replaces the saved draft (nothing is posted); skip: true takes the review off the list to answer, false brings it back. Owners and admins. - path `review_id` (string, required): Review id. - body `draft_reply` (string): The reply draft, up to 4,000 characters. - body `skip` (boolean): true skips the review; false brings it back. - example body: {"draft_reply":"Thank you, Dana! We're glad the new furnace is keeping you warm."} - `POST /v1/google-business/reviews/{review_id}/reply` — Reply to a Google review (scope workspaces:write) Posts text (or the saved draft) as the business's public reply under the review on Google, as the app's Post reply; on a review already answered it replaces the reply. Only reviews that came from Google with the profile connected: one read from Google Maps or pasted in answers 409 copy_by_hand (paste the reply on Google yourself); awaiting_google and not_posted as for posts. Owners and admins. - path `review_id` (string, required): Review id. - body `text` (string): The reply, up to 4,000 characters (default: the saved draft). - example body: {"text":"Thank you, Dana! We're glad the new furnace is keeping you warm."} - `POST /v1/google-business/optimizer/apply` — Apply Profile Optimizer suggestions (scope workspaces:write) Makes the picked suggestions of a Profile Optimizer check (the newest, or run_id) on the business's live Google profile, which everyone sees: categories added, a new description, services, attributes turned on, the Book button linked to one of its calendars, holiday hours. Ids come from the run's suggestions (GET /v1/google-business/optimizer). Each change is recorded and can be undone; dry_run: true asks Google to check them without changing anything. results says what worked. Owners and admins. - body `profile_id` (string): One of its profiles (default its first). - body `run_id` (string): The check (default the newest). - body `categories` (array): Category ids to add (suggestions.categories[].id). - body `description` (string): The description to use, 50-750 characters (the suggested one, edited or not). - body `services` (array): Service ids (suggestions.services[].id). - body `attributes` (array): Attribute ids to turn on (suggestions.attributes[].id). - body `booking_calendar_id` (string): The calendar the Book button opens (suggestions.booking.calendars[].id). - body `holidays` (array): [{ key, closed }] from suggestions.holidays (closed defaults to true). - body `dry_run` (boolean): true: Google validates, nothing changes. - example body: {"workspace_id":"uuid","categories":["categories/gcid:hvac_contractor"],"attributes":["attributes/has_onsite_services"],"dry_run":true} - `POST /v1/google-business/optimizer/changes/{change_id}/undo` — Undo a Profile Optimizer change (scope workspaces:write) Puts what was on the Google profile before that change back (the change ids are in GET /v1/google-business/optimizer, runs[].changes). Owners and admins. - path `change_id` (string, required): Change id. - `POST /v1/map-rankings/keywords` — Track a Map Rankings keyword (scope workspaces:write; uses credits) Tracks where the business ranks on Google Maps for a search, across a grid of points centred on the business (or center_lat / center_lng). On a schedule (weekly by default) its first scan runs within minutes and then on the schedule; each scan costs 0.25 (5x5), 0.5 (7x7), 1 (9x9) or 2 (13x13) credits from the account, the first 3 scans of a business are free. Up to 10 keywords per business. Owners and admins. - body `profile_id` (string): One of its profiles (default its first). - body `keyword` (string, required): What people search, e.g. "furnace repair" (up to 80 characters). - body `grid_size` (number): Points per side: 5, 7 (default), 9 or 13. - body `spacing_m` (number): Meters between points: 402, 805, 1609 (default), 2414, 3219, 4828 or 8047. - body `center_lat` (number): With center_lng: the grid's centre (default the business). - body `center_lng` (number): With center_lat. - body `schedule` (string): Default weekly. - example body: {"workspace_id":"uuid","keyword":"furnace repair","grid_size":7,"schedule":"weekly"} - `DELETE /v1/map-rankings/keywords/{keyword_id}` — Stop tracking a keyword (scope workspaces:write) No more scans for it; its past scans stay readable. Owners and admins. - path `keyword_id` (string, required): Keyword id (GET /v1/map-rankings). - `POST /v1/map-rankings/keywords/{keyword_id}/scan` — Scan a keyword now (scope workspaces:write; uses credits) Starts a scan of the keyword's grid (202): 0.25 to 2 credits by grid size, from the account (free for the first 3 scans of a business); points Google never answers are refunded. One scan of a keyword at a time: while one runs, that one is returned. It takes a few minutes; read it with GET /v1/map-rankings/scans/{scan_id}. 402 when there aren't enough credits. Owners and admins. - path `keyword_id` (string, required): Keyword id. - `POST /v1/listings/scan` — Check the business on the directories (scope workspaces:write) The free check of every directory (202): starts Business Listings for the business, or looks again for the current run (at most every 6 hours). business sets the details every directory gets (default: from its Google profile); they can change until something has been sent. Read the results with GET /v1/listings. Owners and admins. - body `profile_id` (string): One of its profiles (default its first). - body `business` (object): name, street, unit, city, state, zip, country, phone, website, email, category, categories, description, tagline, hours, services, first_name, last_name, year_founded, logo_url, service_area_only. - example body: {"workspace_id":"uuid"} - `POST /v1/listings/start` — Start listing the business (scope workspaces:write; uses credits) Signs the business up, with its details, on every directory the check didn't find it on or found with wrong details, as the app's Start: those listings are public. 8 credits a directory from the account, refunded for each that ends without a listing; credits_charged says how many. Some directories then need the owner (a code, a robot check): GET /v1/listings shows them. Owners and admins. - body `campaign_id` (string): Default the current run (GET /v1/listings). - example body: {"workspace_id":"uuid"} ### Support - `GET /v1/support/tickets` — Support tickets (scope workspaces:read) The sub-account's Support tickets, newest activity first: subject, category, status (open, answered, resolved), who is answering (the assistant or the team), unread state and rating. The agency team sees every ticket; a client admin every ticket of the sub-account; anyone else their own. 403 feature_off while Support is off for the sub-account. - query `status` (string): Filter. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `GET /v1/support/tickets/{ticket_id}` — One support ticket and its messages (scope workspaces:read) Every message in order (the customer, the assistant, the team), with the files' names. Internal notes only for the agency team. - path `ticket_id` (string, required): Ticket id. - `POST /v1/support/tickets` — Open a support ticket (scope workspaces:write) What the sub-account's Support page does: the ticket goes to the account's support team, their AI assistant answers first (usually within a minute; read the ticket for the answer) and hands it to a person when it can't solve it. Replies also arrive by email. Any member of the sub-account; at most 5 new tickets an hour per person. Files are added in the app. 403 feature_off while Support is off for the sub-account. - body `message` (string, required): What is going on (2-20,000 characters). - body `subject` (string): Up to 160 characters. Default: the start of the message. - body `topic` (string): Default question. - example body: {"workspace_id":"uuid","subject":"Texts not sending","message":"Since this morning our texts to new leads fail. We changed nothing.","topic":"problem"} - `POST /v1/support/tickets/{ticket_id}/messages` — Add to a ticket (as the client) (scope workspaces:write) A new message on a ticket the key's person opened (a client admin: any of the sub-account's tickets), as on the Support page. While the assistant handles the ticket it answers again; otherwise the team is told. answered_by says which. The support team answers with POST /v1/support/tickets/{ticket_id}/reply instead (403 here). - path `ticket_id` (string, required): Ticket id. - body `message` (string, required): Up to 20,000 characters. - example body: {"message":"Still failing after the restart."} - `POST /v1/support/tickets/{ticket_id}/reply` — Answer the client (support team) (scope workspaces:write) The support team's reply, as from the Support desk: it shows on the client's Support page, is emailed to them (emailed says whether it went) and pushed to their phone. A reply still holding [check: ...] parts (from the assistant's suggested reply) is refused until they are filled in. The agency's owners and team only; others get 403. - path `ticket_id` (string, required): Ticket id. - body `body` (string, required): The reply, up to 20,000 characters. - example body: {"body":"Thanks Pat, your texting number was paused by the carrier. We've fixed it; texts are going out again."} - `POST /v1/support/tickets/{ticket_id}/notes` — Add an internal note (support team) (scope workspaces:write) A note on the ticket only the support team sees; the client is not told. The agency's owners and team only. - path `ticket_id` (string, required): Ticket id. - body `body` (string, required): The note, up to 20,000 characters. - example body: {"body":"Carrier flagged the number on 10-28. Asked them to lift it."} - `PATCH /v1/support/tickets/{ticket_id}` — Status, priority, assignee, who answers (support team) (scope workspaces:write) The Support desk's changes, applied in this order: assigned_to (a team member's user id who can open the sub-account, or null to unassign; the new assignee is emailed and pushed the ticket), priority, handler (staff: the team answers from now on; assistant: hand it back, and the assistant answers at once if the client is waiting), status (resolved, or open to reopen). If one fails, the ones before it stay. Returns the ticket. The agency's owners and team only. - path `ticket_id` (string, required): Ticket id. - body `status` (string): resolved closes it; open reopens it. - body `priority` (string): Set by hand, it stays even when the assistant suggests another. - body `assigned_to` (string): A team member's user id, or null to unassign. - body `handler` (string): Who answers the client. - example body: {"assigned_to":"uuid","priority":"high","handler":"staff"} ### Dashboard - `GET /v1/activity` — The Activity log (scope workspaces:read) Everything that happened in the sub-account, newest first, as Settings > Activity log shows it: every change (the fields that changed, before and after, secrets hidden) with who made it (a person, an API key, the AI or an automation), their IP and browser, who opened what (contacts, conversations, recordings, exports), and messages, calls, bookings, automation runs, notifications and errors. Keyset paged by next_cursor. summary=true adds the page's counts by type and by day and who did the most. Owners and admins only. - query `days` (number): 1-365, default 30. - query `from` (string): ISO start, instead of days. - query `to` (string): ISO end, default now. - query `category` (string): Comma-separated: change, access, lead, inbound, outbound, ai, call, booking, appointment, automation, notification, webhook, api, error, system. - query `actor` (string): A user id, or user, api, ai, automation, lead or system. - query `lead_id` (string): Only what happened to this lead. - query `search` (string): Words in the title or description, or a contact's name, phone or email. - query `summary` (boolean): Also return counts by type and day and the most active people. - query `tz` (string): IANA time zone for summary days, default UTC. - query `limit` (number): 1-200, default 50. - query `cursor` (string): next_cursor from the previous page. ### Invoices & reviews - `GET /v1/review-funnels` — Review pages (scope workspaces:read) Tools → Review funnel: each review page, which one is the default, its rating threshold, where happy customers are sent, and its public_path (/r/ on the sub-account's domain). - `GET /v1/review-requests` — Who was asked for a review, and what they did (scope leads:read) Sent, opened, rated (1-5), clicked through to a review site, and any private feedback, most recently active first. - query `funnel_id` (string): One review page. - query `lead_id` (string): One lead. - query `rated` (boolean): Only rated (true) or not yet rated (false). - query `since` (string): ISO time, changed at or after. - query `limit` (number): 1-100, default 25. - query `cursor` (string): next_cursor from the previous page. - `POST /v1/leads/{lead_id}/review-link` — A lead's personal review link (scope leads:write) Makes (or returns) the lead's link on a review page, like Copy review link on the lead. Sends nothing; share it however you like. Owners and admins only. - path `lead_id` (string, required): Lead id. - body `funnel_id` (string): Which review page. Default: the default page. ### CRM leads - `PATCH /v1/notes/{note_id}` — Edit a note you wrote (scope leads:write) Note ids are the note events in GET /v1/leads/{lead_id}/timeline. People can edit only their own notes, as in the app. - path `note_id` (string, required): Note id. - body `body` (string, required): The note, max 4000. - example body: {"body":"Prefers a call after 5pm."} - `DELETE /v1/notes/{note_id}` — Delete a note (scope leads:write) Owners and admins. - path `note_id` (string, required): Note id. - `POST /v1/leads/{lead_id}/do-not-contact` — Mark a lead do-not-contact (scope leads:write) Like Do not contact on the Leads page: no more emails, and texts to the lead's number are blocked. The app has no undo, so it takes an owner or admin. - path `lead_id` (string, required): Lead id. ### Account - `GET /v1/keys/self` — Inspect the calling API key (scope keys:read) What this key may do and how much of it is used: `access_level` (read / write / admin / custom) and `scopes`, the `workspace` it is locked to (if any), `rate_limit_per_min`, `credit_budget` (limit, used, remaining and reset date; null when the key has no budget) and `usage_30d` (requests, errors, rate_limited). `type` is `account` (made in Settings → API) or `sub_account` (made in a sub-account's own Settings → API in the client CRM), and `endpoints` gives the API and MCP addresses for the host you called. A sub-account key can call this. ## Errors - 400: Invalid request body or unknown action. Fix the payload; retrying unchanged returns the same error. - 401: Missing, malformed or revoked API key. Re-copy the key from Settings → API. - 402: The account is out of credits for this message or call, or the key's monthly credit budget is used up. Add credits to the account, or raise the key's budget in Settings → API. - 403: The key lacks the scope for this endpoint. `details.code` `account_locked`: this account is locked (paused, or its plan unpaid or ended), so its API keys stop until it opens again. Create a key with that scope in Settings → API; the response names the scope it needs. For `account_locked`, an admin of the account opens the CRM to see why and unlock it. - 404: Unknown route or record. Check the path and the id. - 409: Conflict, e.g. a lead with that phone or email already exists, or the lead is already booked at that time. Also `idempotency_in_progress`: the first request with this Idempotency-Key is still running. Use the id returned in `details`. For `idempotency_in_progress`, send the request again with the same key a moment later. - 429: Per-key rate limit exceeded. Wait for `Retry-After` seconds; read X-RateLimit-Remaining. - 503: Pricing or a limit check is temporarily unavailable. Nothing was charged. Retry with exponential backoff. - 5xx: Transient server or upstream failure. Retry with exponential backoff. ## Webhooks Sub-account webhooks are set up in Settings → Leads → Outbound webhooks, or with /v1/outbound-webhooks, and emit: - `lead.created` — A lead was captured for this sub-account. Payload is a full lead snapshot including custom form fields. - `lead.updated` — The lead's status or pipeline stage changed (other field edits do not fire it). Payload carries previous_status, status, previous_stage_key and stage_key. - `lead.qualified` — The lead was marked qualified. - `appointment.booked` — An appointment was booked for the lead. - `appointment.rescheduled` — An appointment moved to a new time, in the CRM calendar, through the API, by an inbound webhook or by the customer on their appointment page. Payload carries booking_id, lead_id, the new starts_at / ends_at, timezone, host, calendar, meeting and moved_via (app, api, inbound_webhook or customer). - `appointment.cancelled` — A booked appointment was cancelled. - `message.received` — An inbound SMS or email arrived on this sub-account's number or inbox. Payload carries message_id, lead_id, channel, direction, body, from/to and media_urls, and `transport` (imessage or mac_sms) when it came in on one of the sub-account's iMessage Macs. - `message.sent` — An outbound SMS or email was handed to the carrier or mail provider — manual, automated or API-sent. Texts carry `transport`: sms from the business number, imessage or mac_sms when one of the sub-account's Macs sent it. - `message.failed` — An outbound message could not be sent. Payload includes the error and, when the contact-safety cap was hit, a `limit` object. - `call.completed` — An AI receptionist call ended (once per call, after its recap is written; practice calls from Settings excluded). Payload carries call_id, lead_id (null for a caller with no lead), from/to, status, duration_sec, outcome, summary, booking_id and started_at / ended_at. The transcript and recording: GET /v1/calls/{call_id}. - `deal.updated` — A lead was marked won, or a won lead's amount or plan changed later (an amount added from Ad Insights, a plan edited). Payload carries deal_type (one_time or plan), deal_value_cents (the first payment), deal_plan_cents, deal_plan_interval, deal_monthly_cents and deal_expected_total_cents, plus the lead snapshot. Every lead event's snapshot carries the same deal fields. Verification: `X-Webhook-Signature: sha256=`. Each delivery is signed with HMAC-SHA256 over the exact raw request body using the webhook's secret (shown once when it is created). Compute the HMAC over the raw bytes, before JSON parsing, and compare in constant time. `X-Webhook-Event` carries the event name and `X-Webhook-Delivery` a unique delivery id you can use to de-duplicate retries. ## MCP server Streamable HTTP endpoint: https://api.highsierrasystems.com/mcp Auth: `Authorization: Bearer zu-...`, or `?api_key=zu-...` for clients that cannot set headers. Every tool maps onto the REST endpoints above, so access levels, the sub-account lock and rate limits apply the same way. - Account: get_api_key_info - Sub-account setup: get_setup_checklist, manage_offers, manage_calendars, manage_booking_menus, manage_calendar_routes, business_hours, manage_pipeline_stages, manage_custom_fields, lead_routing, manage_alert_recipients, manage_lead_sources, manage_outbound_webhooks, knowledge_base, ai_receptionist, manage_smart_forms, configure_workspace_outreach, ai_texting, nurture_sequence, business_profile, list_phone_numbers - Dashboard & inbox: get_overview, get_usage, list_conversations, update_conversation, pause_lead_ai, list_reply_suggestions, decide_reply_suggestion, reply_ideas, needs_reply, list_calls, get_call, call_campaigns, busy_blocks, ai_lessons, rate_ai_message, invoices, estimates, get_ad_insights, google_ads, google_business, map_rankings, business_listings, manage_google_business, manage_map_rankings, manage_listings, support_tickets, health_score, ai_brain_photos, ai_brain_waiting, get_sales_report, list_activity, reviews - CRM leads: list_recent_leads, list_lead_tags, manage_tags, get_lead, create_lead, update_lead, delete_lead, get_lead_timeline, add_lead_note, set_lead_stage, manage_lead_note, mark_do_not_contact, list_pipeline_stages - Messaging: send_lead_message, scheduled_messages, get_lead_conversation, list_messages, instagram_messenger, get_message, get_message_limits, manage_imessage - Email marketing & contracts: email_campaigns, contracts - Bookings: list_calendars, get_calendar_availability, list_bookings, create_booking, reschedule_booking, cancel_booking, update_booking - Sub-accounts & team: list_workspaces, get_workspace, update_workspace, list_workspace_members, invite_workspace_member, update_workspace_member_role, remove_workspace_member - Forms & automations: list_smart_forms, list_form_submissions, list_workspace_automations, automation_folders, enroll_leads_in_automation, toggle_workspace_automation, manage_workspace_automation, workflow_enrollments ## Machine-readable spec - OpenAPI 3.1: https://api.highsierrasystems.com/openapi.json - This guide: https://api.highsierrasystems.com/llms.txt