Sergio by Serviche
Customer workspaceCampaignsWhy SergioCertificationsFAQBlogLog inRequest access
Log inBook a demoRequest access

Sergio MCP reference

Tool reference

103 tools on the public listing: 6 read-only and 97 that change something. Generated from the server's own tool list, so it matches what tools/list returns.

Quickstart · Why build on Sergio · ChatGPT and Claude setup

Connection

  1. Server: https://sergio.serviche.com/api/agent/mcp. Remote MCP over Streamable HTTP, stateless, JSON responses, POST only. Send Accept: application/json, text/event-stream; without both the server answers 406.
  2. initialize and tools/list work without signing in. tools/call without a token returns 401 with a WWW-Authenticate header pointing at /.well-known/oauth-protected-resource.
  3. AI clients sign in with OAuth (PKCE S256, dynamic client registration; access token 1 hour, refresh token 90 days). Scripts use an agent key (sgo_…) the owner or an admin creates under Add agent, sent as Authorization: Bearer.
  4. One seat covers one business. A signed-in seat's own list can differ from this page: the business's modules, the seat's role and the owner's choices decide it. Call catalog to see yours.

Limits

  1. Per key: 60 requests a minute and 4 at once. Per business: 180 a minute and 8 at once.
  2. Over a limit: HTTP 429 with Retry-After and JSON-RPC error -32029 naming the reason.
  3. A result over 256 KB is refused with result_too_large; narrow the read.
  4. HTTP status codes are only 401 (sign in), 403 (no access, for example feature_not_enabled), 406 (Accept header) and 429 (limit). Every other refusal is a tool error: HTTP 200 with isError: true and structuredContent carrying error, status and message.

Retries

  1. Every act and propose tool (the ones that change the business) requires idempotency_key: 8 to 128 characters of letters, digits and . _ : -. Keys belong to the seat, so rotating an agent key keeps them. events_subscribe and events_ack are safe to repeat without one.
  2. A repeat of a finished call returns the original result with replayed: true. The same key with different inputs is refused (idempotency_key_reused). A call still running answers in_progress; retry after the time it gives.

Pagination

  1. read takes options.limit (up to 100) and options.offset, and answers with returned, total, truncated and next_offset. Order is stable.
  2. query returns at most 100 rows and stops after 3 seconds. events_list takes a cursor and a limit of 1 to 500.

Events

  1. Pull, not push: call events_subscribe once, poll events_list, fetch details with read, then events_ack the cursor.
  2. At least once: dedupe on event_id. Events are kept 7 days (up to 10,000 per business); an older cursor answers cursor_expired, so re-read and subscribe again with restart: true.
  3. Event types: text_in, text_out, email_in, email_out, call_answered, call_missed, voicemail, booking_created, booking_changed, booking_cancelled, staff_clocked_in, staff_not_clocked_in, job_finished, visit_unconfirmed.

Sending

  1. Send tools take two calls. The first returns needs_confirmation with the exact text, the recipient and a confirm_token, and sends nothing. The second, with the token, sends.
  2. A send the business's rules hold (Sending off, an opt-out, quiet hours) still answers completed, with result.held: true and the reason. Check it.

Data freshness

  1. BookingKoala: pulled every night between 1 and 4 AM local time, and read from its notification emails as they arrive. Launch27 and ConvertLabs: synced nightly, read-only.
  2. Texts, emails and calls on the business's connected line and inbox arrive as they happen.

Tools

Identity: catalog, whoami

Read: read

Lookup: findClientByIdentifier

Query: query

Events: events_ack, events_list, events_subscribe

Act: accept_smaller_sync, accept_suggestion, add_client_note, add_staff_member, add_staff_scheduling_rule, answer_google_review_match, answer_handbook_question, approve_follow_up_style, archive_handbook_article, assign_conversation, assign_task, bulk_clear_conversations, cancel_import, clear_staff_availability_override, close_conversation_flow, complete_task, complete_tasks_bulk, create_campaign, create_client, create_contact_list, create_contact_tag, create_draft, create_handbook_article, create_scanner, create_task, decide_company_document_suggestion, declare_lead_sources, delete_campaign, delete_client_note, delete_scanner, delete_task, dismiss_conversation_reminders, dismiss_notification, dismiss_suggestion, disposition_conversation, draft_handbook_edit, edit_campaign, edit_client, edit_contact_list, edit_contact_tag, edit_contacts, edit_draft, edit_flow, edit_handbook_article, edit_lead_step, edit_scanner, edit_staff_member, hold_follow_ups, hold_lead_follow_ups, link_conversation_to_client, log_call, log_handbook_question, merge_conversations, move_lead_journey, open_conversation_by_phone, pin_client_note, read_company_document, record_staff_event, record_tools_access, redraft_lead_step, remove_conversation_flow, remove_staff_scheduling_rule, reopen_task, review_cleaner_roster, review_handbook_edit, review_import_mapping, run_suggestion_now, send_campaign_messages, send_email, send_text, set_conversation_reminder, set_conversation_status, set_flow_archived, set_flow_on, set_flow_start, set_handbook_toolshed_sharing, set_lead_outcome, set_scanner_on, set_staff_availability, set_staff_weekly_hours, skip_task, snooze_conversation, snooze_task, start_campaign, start_conversation_flow, start_group_text, start_history_import, start_spreadsheet_import, track_conversation_as_lead, unsnooze_conversation, update_payroll_settings, update_settings, update_task, upload_spreadsheet

Feedback: report_feedback

Identity

Who your agent is signed in as, and what it can do right now.

catalog What can I do

Read-only

Returns `asks`, a short list of things a person can ask (give your user these when they ask what you can do), then lists every tool this seat can call right now, grouped by family, with whether each one changes anything, and under `held` the actions only a person can do (sending, money, access), each with the reason and where in the app the owner does it, and under `not_lent` every other app action agents cannot do yet, with where a person does it.

No inputs.

whoami Who am I

Read-only

Returns this agent seat: its name, role, member id, the organization it belongs to, the key id this call used, whether the owner allowed it to run SQL queries, and what it reads as (readsAs: "owner" when the owner allowed owner-level reading for this key, else its role) versus what it acts as (actsAs: always its role).

No inputs.

Read

Read the business record. Read-only.

read read

Read-only

Read ANYTHING about the business: read(entity, filters). ENTITIES (key: purpose [main filters]): conversations: The inbox list of conversations [status, from, to, needs_reply, conversation_id, ...] | conversation_transcript: A client's whole history in one timeline [conversation_id, client_ref, from, to, search] | communications: Every text, email and call across the business in ONE read [from, to, direction, channel, contact_type, ...] | calls: Call log [conversation_id, client_ref, from, to, direction, ...] | bookings: Bookings by status/date/client/cleaner [status, frequency, from, to, date_axis, ...] | booking_time_logs: Cleaner clock-in/out records as a SET read [from, to, staff, client_ref, booking_id, ...] | booking_notes: Tiered booking notes + the flat booking note [booking_id] | clients: Look up contacts by id [id, name, name_words, phone, email, ...] | contact_groups: The business's live Contacts tags and lists, as the Contacts page's side nav shows them [kind] | client_standing: Visit count + last visit per client, with the client name [client_ref, client_ids] | client_case_file: Full context for a client's thread [conversation_id, client_ref, question, as_of] | owner_directives: Standing asks the owner gave the team in the team channel [status, from, to] | tasks: Tasks [status, task_id, client_ref, conversation_id, flow, ...] | cockpit_queue: The Sergio cockpit / Needs-Attention queue | activity_log: Audit trail of changes [days, from, to, search, actor, ...] | scheduling_decisions: The scheduling decision log [booking_id, days] | chat_turns: Each Sergio chat turn's AI cost and time, newest first, read from the AI usage log [turn_id, days] | staff_roster: The cleaner/staff roster, counted in code | staff_detail: Detail for one staff member [staff, kind, from, to] | staff_events: Every logged staff event org-wide [from, to, kind, staff, sentiment, ...] | client_checkins: Every client check-in / feedback record org-wide [from, to, client_ref, staff, outcome, ...] | google_reviews: The business's Google reviews as Sergio stores them [match_status, from, to, client_ref, stars, ...] | staff_signals: Clustered staff signals/feedback over a window [days] | staff_scheduling_rules: Per-staff scheduling rules/availability constraints | sops: The business's handbook [search, slug, id, audience] | sop_versions: Versions of ONE handbook article [sop_id] | sop_questions: Questions the team asked that the handbook did not answer [status] | company_documents: SOP files the business uploaded, with the Flows and recurring tasks Sergio suggested... | findings: Product gaps / bugs filed on the /development board | financial_reports: Org-wide money rollups [from, to] | lead_pursuits: The Leads ledger [from, to, active, owed_by, task_status, ...] | campaigns: The Growth campaigns list [status, campaign] | campaign_recipients: Who each campaign reached [campaign, state, client_ref, from, to, ...] | flows: The business's flows as the Automations page lists them [flow, active] | scanners: The business's Scanners as the Scanners page lists them [scanner, enabled] | import_jobs: Imports as the Imports page and Data sources list them [status, source] | conversation_flows: Each time a flow or program [flow, status, outcome, client_ref, from, ...] | settings: Every setting of this business, from the one settings registry [area] | webhooks: Outgoing webhooks | webhook_deliveries: One webhook's delivery log, newest first [webhook_id] | webhook_events: Every event a webhook can receive. read('catalog') gives each entity's full description, every filter and field, and which this caller may read. E.g. read("bookings",{status:"cancelled"}), read("conversation_transcript",{client_ref:"Maria Lopez"}), read("cockpit_queue"), read("settings",{area:"ai"}) to learn which model powers you and where to switch it. A client_ref is a FULL name or an id (a bare first name may need disambiguation. Answer a needs_disambiguation result by re-reading with the candidate's id). from/to dates are the business's local calendar days. A value-set filter (each entity's setFilters in read('catalog'): status, state, outcome…) takes one value, a list (["completed","scheduled"] or "completed,scheduled"), a negation ("!cancelled"), or exclude_<key> (e.g. exclude_status:"cancelled"); an unknown value is an error naming the valid ones. A ref filter (each entity's refFilters in read('catalog'): client_ref, staff) takes one ref, a JSON array of refs (matches any; a single string is always ONE ref, commas included), "!ref" or exclude_<key> to drop, up to 25 refs per read; a ref in the set that matches no one or several people returns that ref's no_match / needs_disambiguation. SEVERAL AT ONCE: conversations (conversation_id or client_ref, up to 10); conversation_transcript (conversation_id or client_ref, up to 10); client_case_file (conversation_id or client_ref, up to 5); staff_detail (staff, up to 10) take a list of values and answer every one in ONE call (items[] in the order asked); never loop one read per person. Everything is org-scoped and read-only; you never pass an organization id. List reads carry returned/total/truncated: when truncated is true you saw only the most recent `returned` of `total` (or of more). Say so plainly and narrow with filters (a date range from/to, a status, a client). TO RETRIEVE A SET COMPLETELY: if truncated, page with options.limit = N (up to 100) and options.offset = 0, N, 2N … until returned < N or offset >= total. Pages are stable (ties break on id), so paging never repeats or skips a row. A group_by read pages its GROUPS the same way: groups_total says how many exist and next_offset (with paging_hint) is the options.offset of the next page. TO COUNT ("how many X", "bookings per status"): read with the filter and use `total`. Issue one filtered read per value and read each `total`; NEVER eyeball or tally a capped page of rows.

InputTypeWhat it is
entity requiredcatalog | conversations | conversation_transcript | communications | calls | bookings | booking_time_logs | booking_notes | clients | contact_groups | client_standing | client_case_file | owner_directives | tasks | cockpit_queue | activity_log | scheduling_decisions | chat_turns | staff_roster | staff_detail | staff_events | client_checkins | google_reviews | staff_signals | staff_scheduling_rules | sops | sop_versions | sop_questions | company_documents | findings | financial_reports | lead_pursuits | campaigns | campaign_recipients | flows | scanners | import_jobs | conversation_flows | settings | webhooks | webhook_deliveries | webhook_eventsThe entity to read, or 'catalog' to list what you can read.
filtersobjectEntity-specific filters (see read('catalog')). An organization id is never a filter.
optionsobjectPaging + projection.

Lookup

Find one record by an exact identifier. Read-only.

findClientByIdentifier findClientByIdentifier

Read-only

Look up a client ID by a single identifier (phone or email). Returns the client ID or null. Simpler than resolveClient. No creation, no merge. Use for a quick check: "is this phone number already a client?".

InputTypeWhat it is
type requiredphone | emailIdentifier type: "phone" or "email".
value requiredstringThe identifier value (phone number or email address).

Query

Structured questions no single read covers. Read-only, on only when the owner turns it on.

query query

Read-only

Run a read-only SQL SELECT over the business database and get rows back. It is the FALLBACK, not the first move: when a read(entity) answers the question (leads, clients, conversations, bookings and the rest of read's catalog), use read, which carries the business's own definitions (e.g. open leads = read lead_pursuits active:true) that raw tables do not. Use query only when read cannot express the question (a count, a GROUP BY, a JOIN across tables, filtering on a column read() does not expose, a discount a customer used, an arbitrary aggregate). SCHEMA: query the org-scoped view schema `soul_read` (NOT public). Every table you can read is a view there, already filtered to THIS business. You never write a WHERE organization_id clause and never pass an org id. START with `client_timeline` for any question about one person or booking: every SMS, call (with AI summary), email, booking and human action in one feed (columns: channel, direction, actor, at, text, ai_summary, sentiment, category, client_id, conversation_id, booking_id). Filter client_id, ORDER BY at DESC, LIMIT. Read `SELECT * FROM schema_notes` once for column semantics (event-time columns, value meanings, columns that lie: e.g. use sent_at not created_at; contact_type = client means a real client). Never guess a column name: before you name a column of any other table you have not listed in this conversation, list THAT table's columns first (one table, never the whole schema): `SELECT column_name FROM information_schema.columns WHERE table_schema='soul_read' AND table_name='<table>'`. Reference tables unqualified (e.g. `FROM bookings`). Search_path is already soul_read. RULES: exactly ONE SELECT statement (a second statement, SET, INSERT/UPDATE/DELETE or DDL is refused). Results cap at 100 rows; the response is {rows, returned, truncated}. When truncated is true, add your OWN aggregation (COUNT/GROUP BY) or a tighter WHERE rather than paging blindly. Dates are stored as the business's local calendar; compare bare dates directly (e.g. scheduled_date BETWEEN '2026-07-01' AND '2026-07-31'). Prefer one precise aggregate query over many row dumps. YOUR ROLE reads only these views here (every other view returns no rows): activity_log, booking_assignments, booking_events, booking_notes, booking_series, bookings, call_transcripts, calls, campaign_recipients, campaigns, checks, claims, client_checkins, client_identifiers, client_pinned_notes, client_relationships, client_staff_relationships, clients, company_documents, contact_list_members, contact_lists, contact_tag_members, contact_tags, conversation_flows, conversation_reads, conversations, emails, flows, import_jobs, leads, messages, org_email_config, org_holidays, organizations, outbound_gate_verdicts, payments, scheduling_rules, sop_categories, sop_question_log, sops, soul_findings, staff_availability_overrides, staff_default_availability, staff_earnings, staff_events, staff_profiles, tasks, team_members.

InputTypeWhat it is
sql requiredstringA single read-only SQL SELECT over the soul_read schema, e.g. "SELECT status, count(*) FROM bookings WHERE scheduled_date BETWEEN '2026-07-01' AND '2026-07-31' GROUP BY status".

Events

A cursor feed of what happened, for agents that react.

events_ack Acknowledge events

Changes data

Stores `cursor` (a next_cursor you received) as this seat's high-water mark, so events_list with no cursor resumes after it. It only moves forward; an older cursor changes nothing.

InputTypeWhat it is
cursor requiredstring

events_list Pull events

Read-only

Returns the next events for this seat, oldest first, after `cursor` (omit it to continue from your last ack). Each event names an arrival by id (a text, email, call, or booking change); fetch its detail with read(). Delivery is at-least-once: dedupe on event_id. Pass next_cursor to the next call, and ack it with events_ack once you have processed the page. An error cursor_expired (410) means events behind your cursor were trimmed (7-day retention or backlog cap): resync through read(), then events_subscribe with restart: true.

InputTypeWhat it is
cursorstring
limitinteger

events_subscribe Subscribe to events

Changes data

Create or update this seat's one event subscription. inputs: which arrivals (omit for all: text_in, text_out, email_in, email_out, call_answered, call_missed, voicemail, booking_created, booking_changed, booking_cancelled, staff_clocked_in, staff_not_clocked_in, job_finished, visit_unconfirmed). contact_types: only arrivals for these contact types. A field you omit keeps its current value, so {paused:true} pauses without touching the filter; pass inputs:null or contact_types:null to go back to all. paused: true stops delivery without losing the cursor, paused: false resumes. restart: true moves your position to now and clears your ack (the resync after cursor_expired, once you have re-read current state). Delivery starts at the moment you first subscribe. Repeating the same call changes nothing.

InputTypeWhat it is
inputstext_in | text_out | email_in | email_out | call_answered | call_missed | voicemail | booking_created | booking_changed | booking_cancelled | staff_clocked_in | staff_not_clocked_in | job_finished | visit_unconfirmed[] | null
contact_typesclient | lead | staff | applicant | other[] | null
pausedboolean
restartboolean

Act

Change something in the business. Every one takes an idempotency_key.

accept_smaller_sync Accept a smaller sync

Changes dataCannot be undone

Applies a booking sync Sergio held back for returning far fewer bookings than it holds, once, and makes that size the new normal, as Accept this smaller sync on Data sources does. job_id is the held sync's import job. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
jobId requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

accept_suggestion Accept a Sergio suggestion

Changes data

Accepts a Sergio suggestion card, as the card's accept does. action "accept" commits it as a task (optionally with your edited title, details or due, ISO 8601 or null); "accept_no_task" resolves it without a task when the work already happened. A card whose move would send a message, move money, open to the public or grant access is refused with where the owner does it; draft instead (create_draft, or run_suggestion_now on a draft card). Pass the same idempotency_key when retrying; a repeat returns the first answer.

InputTypeWhat it is
suggestion_id requiredstring
action requiredaccept | accept_no_task
taskTitlestring
taskDescriptionstring
duestring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

add_client_note Add a note to a client

Changes data

Adds an office note to a client's record (category general, access, preference, alert or scheduling; pinned keeps it surfaced). Only the team sees it; nothing is sent. Pass the same idempotency_key when retrying; a repeat returns the original note.

InputTypeWhat it is
client_id requiredstring
content requiredstring
categorygeneral | access | preference | alert | scheduling
pinnedboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

add_staff_member Add a staff member

Changes data

To rename someone already on the roster, pass rename_staff_id with the new name; the old spelling keeps pointing at them. Otherwise adds a field worker to the roster, as the staff page's Add staff does: name (a profile with that name is reused, never duplicated), optional employment_type (employee or contractor), or client_id to make an existing contact staff (a name clash comes back as name_conflict; call again with link_to_staff_id to link instead). This gives them no sign-in; inviting someone to Sergio is the owner's. Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
name requiredstring
employment_typeemployee | contractor
client_idstring
link_to_staff_idstring
rename_staff_idstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

add_staff_scheduling_rule Add a scheduling rule for a field worker

Changes data

Adds a plain-English scheduling rule for one field worker (staff_id), as Add rule on their Rules tab does, e.g. "Won't work Tuesdays" or "Only mornings in Brooklyn". hardness hard (default: never scheduled against it) or soft (avoided when possible). The same wording again updates the same rule. Answers the worker's rules with their ids. Remove one with remove_staff_scheduling_rule; read every rule with read staff_scheduling_rules. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
staff_id requiredstring
plainEnglish requiredstring
hardnesshard | soft
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

answer_google_review_match Link or unlink a Google review and a client

Changes data

Says which client wrote a Google review, as Contacts > Needs review does: client_id links it (also moving a review linked to the wrong client), client_id null says no client wrote it (unlinking a linked review). A link closes that client's review requests. Find reviews and their ids with read google_reviews. Nothing is sent or posted to Google. Pass the same idempotency_key when retrying.

InputTypeWhat it is
review_id requiredstring
client_id requiredstring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

answer_handbook_question Answer a handbook question

Changes data

Answers or files a logged question (question_id from read entity sop_questions), as Handbook > Admin > Questions does: answer, status (open, answered, needs_new_sop, sop_updated, dismissed), sop_id it belongs to, notes. save_as_sop: true has Sergio write the answer into the handbook (the matching article, or a new one). Pass the same idempotency_key when retrying; a repeat does not save it to the handbook twice.

InputTypeWhat it is
question_id requiredstring
answerstring
statusopen | answered | needs_new_sop | sop_updated | dismissed
sop_idstring | null
notesstring
save_as_sopboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

approve_follow_up_style Approve the lead journeys drafted from follow-up answers

Changes data

Records the owner's approval of the lead journeys drafted from how the business follows up today, as Get started's follow-up step does. The journeys must already be saved as the answers draw them (answers: firstChannel, speed, followUpChannel, tries, overDays, giveUpDays; sources: the journeys approved, as lead sources such as site_thumbtack or web_form; Get started's lead sources map to them). Save the journeys first through the lead follow-up journeys setting (settings.lead_pursuit_program), drawn from these answers; otherwise the route answers journeys_not_saved. Writes no journey and sends nothing. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
answers requiredobject
sources requiredmissed_call | voicemail | answered_call | text | web_form | email | outbound_call | outbound_email | site_thumbtack | site_bark | web_chat[]
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

archive_handbook_article Remove a handbook article

Changes data

Takes an article out of the handbook as its Delete does: it is marked inactive and kept (edit_handbook_article cannot bring it back; a person can). Pass the same idempotency_key when retrying.

InputTypeWhat it is
sop_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

assign_conversation Assign a conversation

Changes data

Assigns a conversation to a teammate, as the thread header's Assign menu does: assigned_member_id is the teammate's id (read entity org_members), or null to unassign; assigned_to (the teammate's exact name) is accepted instead. A name that is not exactly one current teammate is refused. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
assigned_member_idstring | null
assigned_tostring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

assign_task Assign a task

Changes data

Assigns a task to a team member (their member id from read('team_members') or whoami), or unassigns it with null. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
assigned_to requiredstring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

bulk_clear_conversations Clear old conversations in bulk

Changes dataLeaves Sergio

Clears every thread older than a cutoff at once, as the inbox's bulk Clear does (owner or admin seats only): mode date clears threads quiet for olderThanDays (default 14) or since cutoff (ISO date); mode leads clears threads a lead follow-up owns. includeTasks also closes their open tasks; includeReplyOwed also clears threads the customer wrote last in (date mode). The Quo inbox follows when the business's write setting allows. Pass the same idempotency_key when retrying.

InputTypeWhat it is
mode requireddate | leads
olderThanDaysinteger
cutoffstring
includeTasksboolean
includeReplyOwedboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

cancel_import Cancel a running import

Changes data

Cancels a running import (message history or a spreadsheet), as Cancel in the import drawer does; what it already brought in stays. job_id comes from start_history_import or the import list. Pass the same idempotency_key when retrying.

InputTypeWhat it is
job_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

clear_staff_availability_override Clear a worker's schedule change for a date

Changes data

Clears one field worker's schedule change on a date (YYYY-MM-DD), so their normal weekly hours apply again, as Clear on the staff calendar does. To set a change, use set_staff_availability. Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
cleaner_name requiredstring
date requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

close_conversation_flow Mark a conversation's flow done

Changes data

Marks a conversation's flow done, as the flow chip's Mark done does. conversationFlowId names the flow when the thread has more than one. outcome (for example declined) closes it early without marking its steps done; close_note is optional. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
conversationFlowIdstring
outcomestring
close_notestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

complete_task Complete a task

Changes data

Marks a task done, recorded as completed by this seat. A flow-step task also completes its step, as the check box does. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
notestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

complete_tasks_bulk Mark several tasks done

Changes data

Marks up to 200 tasks done at once, as the Tasks page's selection bar does; each closes exactly as its own check box would. Kinds that close only from their own screen (lead follow-ups, flow steps, questions, staff check-ins, rules) are refused per task and reported in results. action "reopen" is the Undo. Pass the same idempotency_key when retrying; a repeat returns the first answer and moves nothing again.

InputTypeWhat it is
ids requiredstring[]
action requireddone | reopen
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_campaign Build a campaign (saved as a draft)

Changes data

Builds a campaign as the Campaigns page's New campaign does, always saved as a draft: name, the messages (steps: the opener first, each { template, delayDays?, channel? text | email | call }), offer, audience (audience_filter, or audience_source { kind: list | view | people | filter }), caps and send window. Templates use Sergio's merge tags ({{Client First Name}}, {{User Company}}, {{Offer}}, {{Offer Expiry Date}} and the rest listed on steps.template), never a hard-coded business or client name. audience_filter takes the builder's own keys (visits, days since last booking, last booking total, days since last contact, frequency, services); audience_mode rolling (default) keeps adding people as they qualify (evergreen), fixed freezes the audience at start. read campaigns returns this vocabulary and existing campaigns to copy from. Sergio's audience rules apply unless your person asks otherwise, so leave those fields out: it leaves out anyone with an upcoming booking (audience_filter.noUpcomingBooking) and anyone another campaign reached lately (contact_floor_days, the business's window, 30 days unless changed), and new matches join on their own (audience_mode rolling). The people a rule leaves out show in the campaign as Excluded by Sergio, where a person can include one anyway, so another campaign running over the same people is not something to warn about. The answer's audience_rules says all this in one sentence: tell your person that sentence when you report the draft. A credit your person names is the offer the message describes (see offer_text); never ask them to apply credits. Nobody is enrolled and nothing is sent until it starts: start_campaign (your person sees every message first and says yes), or Start campaign in the app; turning on automatic sending stays the owner's. Pass the same idempotency_key when retrying; a repeat returns the same draft.

InputTypeWhat it is
name requiredstring
offer_textstring | nulloffer_text is the offer, written the way the builder writes it ("$25 off your next booking", "10% off your next booking", "a free fridge clean"); {{Offer}} sends those exact words to every recipient. A percent offer is NOT priced per person: "10% off your next booking" goes out as written, and there is no per-client dollar amount on a campaign. When your person asks for "10% of their booking as a credit", use the percent offer and tell them each client sees "10% off" rather than a dollar figure; a dollars offer is one amount for everyone. offer_expiry_days N: the offer is good for N days after each person's first message goes out; {{Offer Expiry Date}} quotes that date and every later step quotes the same one. When your person says to give clients a credit ("a $29.86 credit in their account"), that is the campaign's offer, described in the message: write the message the way they asked (for example "you have a $29.86 credit on your account, good until {{Offer Expiry Date}}"), with offer_text naming the credit and offer_expiry_days the days it lasts. Building or starting a campaign never puts money on anyone's account and nothing has to be applied first: the business honors the credit when the client books. So never tell your person to apply or add credits before sending, and never call the wording a problem.
offer_expiry_daysinteger | nullDays the offer stays good after each person's first message; {{Offer Expiry Date}} quotes the date.
queue_expiry_daysinteger
daily_capinteger
min_days_since_visitinteger
cooldown_daysinteger
contact_floor_daysinteger | null
hold_negative_feedbackboolean
text_by_email_subjectstring | nullThe one email subject every text step takes when it goes by email to someone Sergio may not text. An email step keeps its own.
stepsobject[]
short_codestring | null
colorstring | null
send_time_localstring | null
send_window_hoursinteger | null
enrollment_sourceaudience_filter | manual | trigger
audience_moderolling | fixed
audience_filterobjectWho the campaign is for, as the builder's Audience section sets it. Use these keys only; every key given must hold.
audience_sourceobject | nullInstead of audience_filter, follow Contacts: { kind: "list", listId } | { kind: "view", viewId } | { kind: "people", clientIds: [...] } | { kind: "filter", query } (a Contacts filter).
auto_sendboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_client Add a contact

Changes data

Adds a contact as the Add contact form does: a name, a phone (with area code) or an email is enough. contact_type picks client (default), lead, applicant, staff or other. A phone or email that already belongs to a contact is refused with that contact (duplicate_contact, its id in the message); use it, or pass createAnyway: true only for a different person who shares it (a shared phone then stays with its owner). Look a person up first with findClientByIdentifier or read. Pass the same idempotency_key when retrying; a repeat returns the contact the first call made. platform_customer links the contact to its booking platform customer id (platform defaults to the company's one booking platform); an id another contact holds is refused with that contact.

InputTypeWhat it is
namestring
phonestring
emailstring
contact_typeclient | lead | applicant | staff | other
createAnywayboolean
platform_customerobject
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_contact_list Make a contact list

Changes data

Makes a contact list on the Contacts page, or answers the live one with that name. Add people to it with edit_contacts (op add_to_list). Pass the same idempotency_key when retrying.

InputTypeWhat it is
name requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_contact_tag Make a contact tag

Changes data

Makes a tag on the Contacts page, or answers the live one with that name. Tag people with edit_contacts (op add_tags). Pass the same idempotency_key when retrying.

InputTypeWhat it is
name requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_draft Draft a message

Changes data

Writes a message into a client conversation's draft box. It never sends: a person on the team reviews the exact text and presses Send in Sergio, where the organization's sending policy applies. Give conversationId, or clientId to use that client's conversation. Pass the same idempotency_key when retrying; a repeat returns the original draft.

InputTypeWhat it is
conversationIdstring
clientIdstring
body requiredstring
channelsms | email
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_handbook_article Add a handbook article

Changes data

Adds an article (SOP) to the handbook, as Handbook > Admin > New SOP does: title, content_md (markdown), optional category, tags, audience (cleaner = staff, va = office), bucket (A, B or C), licensed (from a franchise or licensed manual: never shared outside the business). Nothing is sent. Before adding anything to the handbook, search the sops read entity by the topic (search finds by meaning): when an article already covers it, put the new text into that article (edit_handbook_article with its full content_md, the new lines placed where they belong, or draft_handbook_edit) instead of a new one; create a new article only when none fits, and say which closest article you found and why it did not fit. Audience comes from the person's words: cleaner SOPs, cleaning standards or staff = cleaner; policies, office or VA = va; when the words do not say, ask in one line. Ask which place, in one line naming both, when two places fit the person's words equally well: two articles that both match; a place the person named outright is never a tie. The proposed change is the confirmation, so never ask "should I add this?" first. Pass the same idempotency_key when retrying; a repeat returns the same article.

InputTypeWhat it is
title requiredstring
content_md requiredstring
categorystring
tagsstring[]
audiencecleaner | va
bucketA | B | C
licensedboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

create_scanner Create a Scanner

Changes data

Saves a new Scanner, as Save on New Scanner does: question (required), and optionally name, inputs, look-again timing, who gets the task, due rule, destination, contact types, and enabled (on or off; there is no trial mode). Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
namestring
question requiredstring
inputsstring[]
refinementsany[]
look_again_kindminutes | next_morning
look_again_minutesinteger | null
assignee_kindteam | member | sender
assignee_member_idstring | null
due_rulesame_day | next_business_day | within_hours | none
due_hoursinteger | null
destinationstring
contact_typesstring[] | null
rollupboolean
enabledboolean
draftboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

create_task Create a task

Changes data

Adds a task to the team's work queue, optionally tied to a client or conversation and due at a time (ISO 8601). Pass the same idempotency_key when retrying; a repeat returns the original task.

InputTypeWhat it is
title requiredstring
descriptionstring
due_datestring
prioritylow | medium | high | urgent
client_idstring
conversation_idstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

decide_company_document_suggestion Approve, edit or skip a document suggestion

Changes data

Decides one suggestion Sergio read from an uploaded document (itemId from read_company_document or read entity company_documents), as the setup guide's taps do: approve creates the flow as a draft that is OFF or the recurring task PAUSED (nothing runs or sends until a person turns it on); edit rewrites its sentence; skip drops it. approve with sentence applies that edit first. A repeat returns the same created row.

InputTypeWhat it is
document_id requiredstring
itemId requiredstring
action requiredapprove | skip | edit
sentencestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

declare_lead_sources Say where leads come from

Changes data

Records where the business gets its leads (keys from the setup guide list, for example thumbtack, google_lsa, yelp, website, other; other needs its words), as Get started's lead sources step does. An answer only: it opens and sends nothing. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
keys requiredstring[]
otherstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

delete_campaign Delete a campaign

Changes dataCannot be undone

Deletes a campaign as Delete on its card does: its queued messages are pulled back first; messages already sent stay in their threads. It cannot be undone; to stop it for now, edit_campaign with status paused. Pass the same idempotency_key when retrying.

InputTypeWhat it is
campaign_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

delete_client_note Delete a client note

Changes dataCannot be undone

Deletes a note from a contact's card outright, as the note's Delete does. It cannot be undone (the activity log keeps what it said). Pass the same idempotency_key when retrying; a repeat after the note is gone answers success.

InputTypeWhat it is
client_id requiredstring
noteId requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

delete_scanner Delete a Scanner

Changes dataCannot be undone

Deletes a Scanner, as Delete in its editor does; the tasks it already made stay. To pause it instead, use set_scanner_on with enabled false. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
scanner_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

delete_task Delete a task

Changes dataCannot be undone

Deletes a task outright, as the task menu's Delete does. It cannot be undone; to say a task is not needed, use skip_task instead. Deleting a Scanner's task tells that Scanner it was wrong. Pass the same idempotency_key when retrying; a repeat returns the first delete's answer.

InputTypeWhat it is
task_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

dismiss_conversation_reminders Dismiss a conversation's reminders

Changes data

Dismisses every open reminder on a conversation, as the bell's Dismiss does. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

dismiss_notification Dismiss a notification

Changes data

Dismisses a notification card (action "dismiss"), snoozes it for its own snooze time ("snooze"), or marks it read ("read"), as the card's controls do. Pass the same idempotency_key when retrying.

InputTypeWhat it is
notification_id requiredstring
action requireddismiss | snooze | read
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

dismiss_suggestion Dismiss a Sergio suggestion

Changes data

Dismisses a Sergio suggestion card, as the card's dismiss does. reason is optional ("Not needed" tells the Scanner that raised it that it was wrong). Pass the same idempotency_key when retrying; a repeat returns the first answer.

InputTypeWhat it is
suggestion_id requiredstring
reasonstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

disposition_conversation Record a quiet thread's disposition

Changes dataLeaves Sergio

Records why a quiet thread needs no reply, as the clear gate's picker does: spam (the contact becomes spam; its lead work stops and its Quo card is tagged when the business's write setting allows), lead (the contact becomes a lead), reengage (tags the contact for a later marketing touch) or no_action. It does not clear the thread. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
disposition requiredspam | lead | reengage | no_action
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

draft_handbook_edit Have Sergio draft an article edit

Changes data

Asks Sergio to draft an edit to an article, as the article's Ask Sergio does: with context, the smallest change that does what it says; without, a general cleanup. The draft waits as a pending version (review_handbook_edit approves or rejects it). When the person gave the exact words to add, edit_handbook_article with them is the direct change; use this when they asked for a rewrite or cleanup. Before adding anything to the handbook, search the sops read entity by the topic (search finds by meaning): when an article already covers it, put the new text into that article (edit_handbook_article with its full content_md, the new lines placed where they belong, or draft_handbook_edit) instead of a new one; create a new article only when none fits, and say which closest article you found and why it did not fit. Audience comes from the person's words: cleaner SOPs, cleaning standards or staff = cleaner; policies, office or VA = va; when the words do not say, ask in one line. Ask which place, in one line naming both, when two places fit the person's words equally well: two articles that both match; a place the person named outright is never a tie. The proposed change is the confirmation, so never ask "should I add this?" first. Pass the same idempotency_key when retrying; a repeat returns the same draft without asking the model again.

InputTypeWhat it is
sop_id requiredstring
contextstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_campaign Edit, pause or archive a campaign

Changes data

Edits a campaign as its builder does (the fields you pass change; the rest stay), or pauses (status paused, pulls back its queued sends) or archives it. Turning automatic sending off (auto_send false) is open. To start or resume one, use start_campaign (your person confirms first). Held for the owner, refused with where: starting it here, turning automatic sending on, and changing the messages, audience, caps or send window of a started campaign that sends automatically (turn auto_send off first, in the same call or before). Templates, offer and audience_filter follow the same rules as create_campaign (listed on each field). Pass the same idempotency_key when retrying.

InputTypeWhat it is
campaign_id requiredstring
namestring
statuspaused | archived
dismissed_tipsstring[]
offer_textstring | nulloffer_text is the offer, written the way the builder writes it ("$25 off your next booking", "10% off your next booking", "a free fridge clean"); {{Offer}} sends those exact words to every recipient. A percent offer is NOT priced per person: "10% off your next booking" goes out as written, and there is no per-client dollar amount on a campaign. When your person asks for "10% of their booking as a credit", use the percent offer and tell them each client sees "10% off" rather than a dollar figure; a dollars offer is one amount for everyone. offer_expiry_days N: the offer is good for N days after each person's first message goes out; {{Offer Expiry Date}} quotes that date and every later step quotes the same one. When your person says to give clients a credit ("a $29.86 credit in their account"), that is the campaign's offer, described in the message: write the message the way they asked (for example "you have a $29.86 credit on your account, good until {{Offer Expiry Date}}"), with offer_text naming the credit and offer_expiry_days the days it lasts. Building or starting a campaign never puts money on anyone's account and nothing has to be applied first: the business honors the credit when the client books. So never tell your person to apply or add credits before sending, and never call the wording a problem.
offer_expiry_daysinteger | nullDays the offer stays good after each person's first message; {{Offer Expiry Date}} quotes the date.
queue_expiry_daysinteger
daily_capinteger
min_days_since_visitinteger
cooldown_daysinteger
contact_floor_daysinteger | null
hold_negative_feedbackboolean
text_by_email_subjectstring | nullThe one email subject every text step takes when it goes by email to someone Sergio may not text. An email step keeps its own.
stepsobject[]
short_codestring | null
colorstring | null
send_time_localstring | null
send_window_hoursinteger | null
enrollment_sourceaudience_filter | manual | trigger
audience_moderolling | fixed
audience_filterobjectWho the campaign is for, as the builder's Audience section sets it. Use these keys only; every key given must hold.
audience_sourceobject | nullInstead of audience_filter, follow Contacts: { kind: "list", listId } | { kind: "view", viewId } | { kind: "people", clientIds: [...] } | { kind: "filter", query } (a Contacts filter).
auto_sendboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_client Edit a contact

Changes dataLeaves Sergio

Edits a contact as the contact card's pencil does: name, phone (with area code), email, company_name, address (keep its zip if it had one), access_notes, special_instructions, has_pets, pet_details, preferred_cleaner, preferences, availability_notes, contact_type. Send only the fields to change; a contact always keeps a name, phone or email. expected (field -> the value you read) refuses the save if someone changed it since (stale_write). A rename reaches the Quo card when the business's write setting allows. platform_customer links the contact to its booking platform customer id; an id another contact holds is refused with that contact. Pass the same idempotency_key when retrying.

InputTypeWhat it is
client_id requiredstring
namestring | null
phonestring | null
emailstring | null
company_namestring | null
addressstring | null
access_notesstring | null
special_instructionsstring | null
has_petsboolean | null
pet_detailsstring | null
preferred_cleanerstring | null
preferencesstring | null
availability_notesstring | null
contact_typeclient | lead | applicant | staff | other | spam
expectedobject
platform_customerobject
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_contact_list Rename or archive a contact list

Changes data

Renames a contact list or archives it (archived: true; its people keep their other lists), as the Contacts page's list menu does. Pass the same idempotency_key when retrying.

InputTypeWhat it is
list_id requiredstring
namestring
archivedboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_contact_tag Rename or archive a contact tag

Changes data

Renames a Contacts tag or archives it (archived: true), as the Contacts page's tag menu does. Pass the same idempotency_key when retrying.

InputTypeWhat it is
tag_id requiredstring
namestring
archivedboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_contacts Edit contacts in bulk

Changes dataLeaves Sergio

Applies one edit to up to 5000 contacts, as the Contacts page's selection bar does: op add_to_list / remove_from_list (listId), add_tags / remove_tags (tagIds), set_service_category (value residential, commercial, both or null), set_lead_source (value thumbtack, google_lsa, yelp, bark, website_form, google_business_profile, referral, booking_software, direct, web_chat, other or null), set_type (type client, lead, applicant, other), archive, mark_spam (at most 500 for the last three; a type change or spam tags or untags the Quo card when the business's write setting allows). Each contact answers succeeded, skipped (already so) or failed. Pass the same idempotency_key when retrying; every op is safe to repeat.

InputTypeWhat it is
ids requiredstring[]
op requiredadd_to_list | remove_from_list | add_tags | remove_tags | set_service_category | set_lead_source | set_type | archive | mark_spam
listIdstring
tagIdsstring[]
valuestring | null
typeclient | lead | applicant | other
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_draft Edit or discard a draft

Changes data

Edits a draft in a conversation's draft box, as a person typing in it does: body, subject (email), whyNote, isReady, or status 'discarded' to throw it away. Nothing is sent; a person still presses Send. draft_id comes from create_draft or read. Pass the same idempotency_key when retrying.

InputTypeWhat it is
draft_id requiredstring
bodystring
subjectstring | null
whyNotestring | null
isReadyboolean
statusactive | discarded
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_flow Rename a flow or change its description

Changes data

Changes a flow's name or description, as its editor on the Automations page does. Send only what changes. Its steps and how it starts are set in the editor (how it starts: set_flow_start). flow_id comes from read('flows'). Pass the same idempotency_key when retrying.

InputTypeWhat it is
flow_id requiredstring
namestring
descriptionstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_handbook_article Edit a handbook article

Changes data

Edits a handbook article as its Edit page does: title, content_md, category, tags, audience, bucket, is_published, exclude_from_suggestions. Send only the fields to change (sop_id from read entity sops); content_md replaces the whole body, so read the article in full (read sops with id) and send all of it with the change in place. Saving supersedes pending suggestions on it. Before adding anything to the handbook, search the sops read entity by the topic (search finds by meaning): when an article already covers it, put the new text into that article (edit_handbook_article with its full content_md, the new lines placed where they belong, or draft_handbook_edit) instead of a new one; create a new article only when none fits, and say which closest article you found and why it did not fit. Audience comes from the person's words: cleaner SOPs, cleaning standards or staff = cleaner; policies, office or VA = va; when the words do not say, ask in one line. Ask which place, in one line naming both, when two places fit the person's words equally well: two articles that both match; a place the person named outright is never a tie. The proposed change is the confirmation, so never ask "should I add this?" first. Pass the same idempotency_key when retrying.

InputTypeWhat it is
sop_id requiredstring
titlestring
content_mdstring
categorystring | null
tagsstring[]
audiencecleaner | va
bucketA | B | C | null
is_publishedboolean
exclude_from_suggestionsboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_lead_step Change a step in a lead's follow-ups

Changes data

Changes one step of one lead's follow-ups, as the journey list does. Send one or more of: dueAt (ISO time, or null for the plan's timing; must stay after the step before it), channel ('message', 'email', 'call', 'reply', or null for the plan), removed (true takes it out, false puts it back), keep: true (its custom text is still right after the latest conversation). Or addAfter ('message', 'email', 'call' or 'reply') alone to add a step after it (the new step's id comes back). The step's words are your person's to change in the app. step_id comes from the lead's journey. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
step_id requiredstring
dueAtstring | null
channelmessage | email | call | reply | null
removedboolean
keepboolean
addAftermessage | email | call | reply
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

edit_scanner Edit a Scanner

Changes data

Changes a Scanner, as its editor on the Scanners page does: any of name, question, inputs, look-again timing, who gets the task, due rule, destination, contact types, enabled. scanner_id comes from read('scanners'). Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
scanner_id requiredstring
namestring
questionstring
inputsstring[]
refinementsany[]
look_again_kindminutes | next_morning
look_again_minutesinteger | null
assignee_kindteam | member | sender
assignee_member_idstring | null
due_rulesame_day | next_business_day | within_hours | none
due_hoursinteger | null
destinationstring
contact_typesstring[] | null
rollupboolean
enabledboolean
draftboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

edit_staff_member Change a staff member's details

Changes data

Changes one staff member (staff_id, from read staff_roster or staff_detail) as Save in their staff drawer does. Pass only what changes: employmentType (employee reads Staff, contractor reads Contractor), payRateCents with payRateUnit (hour, visit or percent; null clears), publicBookable (customers can pick them on the booking page), portalBookable (clients can pick them in the portal), payHidden (hide their pay from payroll views), venmo / zelle (tip handles; empty clears). To rename, use add_staff_member with rename_staff_id. Ending someone's employment is done by a person on the staff page. Nothing is sent. For several people, call once per person. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
staff_id requiredstring
employmentTypeemployee | contractor
payRateCentsinteger | null
payRateUnithour | visit | percent | null
publicBookableboolean
portalBookableboolean
payHiddenboolean
venmostring | null
zellestring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

hold_follow_ups Hold automatic follow-ups

Changes data

Puts a lap's automatic follow-ups on hold, as its Hold follow-ups switch does: lead follow-ups, a feedback check-in and a review request all obey the one hold. No step goes out on its own; each is drafted for a person. Turning them back on is your person's, in the app. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

hold_lead_follow_ups Hold automatic follow-ups

Changes data

Puts a lap's automatic follow-ups on hold, as its Hold follow-ups switch does: lead follow-ups, a feedback check-in and a review request all obey the one hold. No step goes out on its own; each is drafted for a person. Turning them back on is your person's, in the app. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

link_conversation_to_client Link a conversation to a contact

Changes data

Links a conversation to a contact, as the inbox's Link to a contact does: if the contact already has a one-to-one thread, it is folded into this one, and an email thread's address is saved to the contact. Sergio learns the correction for later emails. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
client_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

log_call Log a call to a contact

Changes data

Logs a phone call the team made outside the phone system (a cell phone, a desk phone) on a contact, as the contact pane's Log a call does. outcome: answered (someone picked up), no_answer, or voicemail (you left one). Optional note (what was said) and at (ISO time the call happened; now when left out, never in the future). The call joins the contact's history and moves their Lead status: an answered call reads In discussion; no answer or a voicemail, with nothing back from them, reads Contacted (a quote, a booking or a status a person set still wins). The answer carries leadStatus, where they stand now. Calls made through the connected phone system are recorded already; do not log those. Nothing is sent. Pass the same idempotency_key when retrying; a repeat returns the original call.

InputTypeWhat it is
client_id requiredstring
outcome requiredanswered | no_answer | voicemail
notestring
atstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

log_handbook_question Log a handbook question

Changes data

Logs a question the handbook does not answer, as Handbook's Ask a question does (optional sop_id of the article it is about, asked_by_name, channel app, sms, call or in-person). Pass the same idempotency_key when retrying; a repeat returns the same question.

InputTypeWhat it is
question requiredstring
sop_idstring
asked_by_namestring
channelapp | sms | call | in-person
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

merge_conversations Merge two conversations

Changes dataCannot be undone

Moves everything in conversation_id (messages, calls, emails, tasks) into target_conversation_id and removes the empty one, as the thread menu's Merge does. It cannot be split back. Pass the same idempotency_key when retrying; the same pair merges once.

InputTypeWhat it is
conversation_id requiredstring
target_conversation_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

move_lead_journey Move a lead to another journey

Changes data

Moves a lead to another follow-up journey (segmentId, as Settings > Lead follow-ups names them: read the lead program), at the same place in the sequence, as the lead's journey tag does. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
segmentId requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

open_conversation_by_phone Open a conversation for a phone number

Changes data

Opens (or finds) the one conversation for a phone number nobody is saved under, as the inbox search's Text <number> does. Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
phone requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

pin_client_note Pin or unpin a client note

Changes data

Pins a note to the top of a contact's card (pinned: true) or unpins it (false), as the note's pin on the contact card does. noteId comes from read (entity client notes). Pass the same idempotency_key when retrying.

InputTypeWhat it is
client_id requiredstring
noteId requiredstring
pinned requiredboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

read_company_document Have Sergio read an uploaded document

Changes data

Has Sergio read one uploaded company document (document_id from read entity company_documents) for Flows and recurring tasks it describes, as the setup guide's Your SOPs step does. Creates nothing; returns the suggestions (decide each with decide_company_document_suggestion). A document already read returns its list without a second read.

InputTypeWhat it is
document_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

record_staff_event Record a warning, kudos or note for a field worker

Changes data

Adds one entry to a field worker's (staff_id) staff log and their attendance and feedback counts: kind warning (a conduct warning), kudos, note, client_feedback (with sentiment), or sick, late, no_show. A sick day, late arrival or no-show that cancelled or moved a visit is recorded by cancelling or reassigning that booking with the cleaner's reason instead, so do not record those twice. occurredOn is YYYY-MM-DD (default today); body is the detail in plain words. Nothing is sent to the worker. Pass the same idempotency_key when retrying.

InputTypeWhat it is
staff_id requiredstring
kind requiredwarning | kudos | note | client_feedback | sick | late | no_show
body requiredstring
occurredOnstring
sentimentpositive | neutral | negative
clientIdstring
bookingIdstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

record_tools_access Record the business's other tools

Changes data

Records the tools the business uses today and whether Serviche was given access to each, as Get started's Your tools step does: action pick (tools: [{ id } or { name }]), none, mark (tool, provided, note) or unmark (tool). Nothing leaves Sergio. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
action requiredpick | none | mark | unmark
toolsobject[]
toolstring
providedboolean
notestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

redraft_lead_step Redraft a lead's upcoming text step

Changes data

Rewrites the text of a lead's upcoming step that a person sends, from the conversation so far, as the journey's Update draft does (one AI draft, billed like the composer's Draft). Refused for a call step, a step Sergio sends on its own, or a step already past. Nothing is sent. task_id is the lead (read entity tasks); step_id is the step's id from the lead's journey. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
step_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

remove_conversation_flow Remove a flow from a conversation

Changes data

Takes one flow off a conversation, as the flow chip's Remove does; its open step tasks are removed. conversationFlowId names the flow. reason is optional. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
conversationFlowId requiredstring
reasonstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

remove_staff_scheduling_rule Remove a field worker's scheduling rule

Changes data

Removes one plain-English scheduling rule (ruleId, from add_staff_scheduling_rule or read staff_scheduling_rules) from a field worker (staff_id), as remove on their Rules tab does. Answers the rules left. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
staff_id requiredstring
ruleId requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

reopen_task Reopen a task

Changes data

Reopens a done or dismissed task, clearing its completion. reopen_reason says briefly why (required, it rides the audit row). A lead follow-up (pursuit) task is refused: reopening it can queue a message, so a person does it. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
reopen_reason requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

review_cleaner_roster Sort a cleaner name from bookings

Changes data

Sorts one cleaner name found on bookings, as the Get started card's Review your cleaner roster does: action add (adds them to the roster and links their past jobs), not_staff (this name is not one of our cleaners), or link (it is staffId under another spelling; links their past jobs). Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
action requiredadd | not_staff | link
name requiredstring
staffIdstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

review_handbook_edit Approve or reject a drafted article edit

Changes data

Approves (the draft becomes the article's text) or rejects a pending drafted version of an article (version_id from draft_handbook_edit or read entity sop_versions), as the article's Approve and Reject do. The same decision again answers success; the other decision on a reviewed version is refused. Pass the same idempotency_key when retrying.

InputTypeWhat it is
sop_id requiredstring
versionId requiredstring
action requiredapprove | reject
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

review_import_mapping Approve or discard a spreadsheet's columns

Changes data

Settles an import waiting at the column review, as its review card does: decision approve (the import runs with the confident columns plus keepFields; keepValues and assignValues teach status words) or discard (nothing is written). Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
jobId requiredstring
decision requiredapprove | discard
keepFieldsstring[]
keepValuesstring[]
assignValuesobject[]
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

run_suggestion_now Run a Sergio card now

Changes data

Runs a Sergio card's move now, as the card's "Run this now" does. action_type is the card's action type (for example create_draft). A move that sends, moves money, opens to the public or grants access is refused with where the owner does it; a move that writes to an outside system (booking changes) is not lent to agents yet. Pass the same idempotency_key when retrying; the move keys on the card, so it never runs twice.

InputTypeWhat it is
suggestion_id requiredstring
action_type requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

send_campaign_messages Send a campaign's ready messages (after your person confirms)

Changes dataTwo-step confirmLeaves Sergio

Sends a started campaign's drafted messages that are ready, on your person's order, as Send in its Ready to send does, as Manual sends under the business's Sending setting, spread over the campaign's send window. First call without confirm_token: nothing is sent; you get a preview (each person and the exact finished text they get, up to 50 at a time) and a confirm_token. Show your person the preview word for word, and only after they say yes, call again with the same arguments and the SAME idempotency_key, plus confirm_token: exactly the messages shown are sent. If Sending is switched off the answer says so with the link; only the owner turns it on, in Sergio. Never send something nobody asked for.

InputTypeWhat it is
campaign_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
confirm_tokenstringFrom the preview, after your person said yes. Leave it out to get the preview.

send_email Send an email (after your person confirms)

Changes dataTwo-step confirmLeaves SergioCannot be undone

Emails a client from the business mailbox on your person's order, as a Manual send under the business's Sending setting. First call without confirm_token: nothing is sent; you get a preview (to, subject and the exact text) and a confirm_token. Show your person the preview word for word, and only after they say yes, call again with the same arguments and the SAME idempotency_key, plus confirm_token. replyToEmailId threads it as a reply to that inbound email.

InputTypeWhat it is
conversation_id requiredstring
to requiredstring
subject requiredstring
body requiredstring
replyToEmailIdstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
confirm_tokenstringFrom the preview, after your person said yes. Leave it out to get the preview.

send_text Send a text (after your person confirms)

Changes dataTwo-step confirmLeaves Sergio

Texts a client or teammate on your person's order, from the business number, as a Manual send under the business's Sending setting. Use it whenever your person asks you to text someone now, with their words or words you wrote for them ("text today's cleaners about the weather"); create_draft leaves it for someone else to send later. First call without confirm_token: nothing is sent; you get a preview (who it goes to and the exact text) and a confirm_token. Show your person the preview word for word, and only after they say yes, call again with the same arguments and the SAME idempotency_key, plus confirm_token. Several people: one preview each, shown together, one yes covers the ones they approve. Never send something nobody asked for, or while nobody is watching; that is a draft (create_draft). Give conversationId (one-to-one: to defaults to the conversation's number); for a cleaner or contact without one, read clients (contact_type 'staff' for cleaners) for the phone, then open_conversation_by_phone.

InputTypeWhat it is
conversationId requiredstring
tostring
body requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
confirm_tokenstringFrom the preview, after your person said yes. Leave it out to get the preview.

set_conversation_reminder Set a reminder on a conversation

Changes data

Adds a reminder on a conversation, as the thread's bell does: remind_at (ISO 8601) and an optional note become a task due then. hide_until_due: true also tucks the thread away until the reminder is due (a reply from the person brings it back). Pass the same idempotency_key when retrying; a repeat returns the first reminder.

InputTypeWhat it is
conversation_id requiredstring
remind_at requiredstring
notestring
hide_until_dueboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_conversation_status Mark a conversation done, or reopen it

Changes dataLeaves Sergio

Marks a thread done (status resolved) or reopens it (status new), as the inbox's Done and Reopen do; the Quo inbox follows when the business's write setting allows. A thread that still owes the customer a reply is refused unless replyOwedOverride is true (say why to your person first). Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
status requiredresolved | new
replyOwedOverrideboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_flow_archived Archive or un-archive a flow

Changes data

Archives a flow as its Archive on the Automations page does (archived true): it leaves the flow pickers and the router but is kept, and runs in progress are unaffected. archived false un-archives it. flow_id comes from read('flows'); archive several by calling once per flow. Pass the same idempotency_key when retrying.

InputTypeWhat it is
flow_id requiredstring
archived requiredboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_flow_on Turn a flow on or off

Changes data

Turns a flow on or off, as its On switch on the Automations page does. Turning it on runs the same publish check (a refusal says what is missing); turning it off ends its runs in progress. flow_id comes from read('flows'). Pass the same idempotency_key when retrying.

InputTypeWhat it is
flow_id requiredstring
is_active requiredboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_flow_start Change how a flow starts

Changes data

Changes how one of this business's flows starts ("Starts when" in Automations) and whether it is on, exactly as the Automations editor's save does. starts_when "contact" means "You add it to a contact": nothing starts the flow by itself. Any other value starts it automatically on that booking event. Switching a start off ("contact") or turning a flow off (active false; its runs in progress end) is open to this seat. Starting a flow on an event or turning a flow on is owner-level: available only when the owner turned on "Let this agent change owner settings" for this seat; the owner is told about each such change. A flow that starts on every upcoming job (starts_when_words says so) turns on only after a person confirms how many jobs it covers, which this tool cannot do: it comes back refused with that count, and the owner turns it on in Automations. Picking a booking event here makes a flow start only on jobs from then on. read("flows") shows each flow and its current start. Events: booking_created (New job booked); booking_changed (Job changed); booking_cancelled (Job cancelled); staff_clocked_in (Cleaner clocked in); staff_not_clocked_in (Cleaner hasn't clocked in); job_finished (Job finished); visit_unconfirmed (Past job not marked done in the booking platform); card_declined (Card declined); review_received (Review received); review_low_rating (Low-star Google review); staff_on_the_way (Cleaner tapped On the way); staff_clocked_out (Cleaner clocked out); staff_running_late (Cleaner says they are running late); staff_not_on_the_way (Cleaner hasn't tapped On the way); staff_not_clocked_out (Cleaner hasn't clocked out); staff_clocked_in_twice (Cleaner clocked in on two jobs at once); staff_schedule_request (Cleaner asked to change their schedule). Pass the same idempotency_key when retrying; a repeat returns the original result.

InputTypeWhat it is
flow_id requiredstringThe flow id (from read("flows")).
starts_whencontact | booking_created | booking_changed | booking_cancelled | staff_clocked_in | staff_not_clocked_in | job_finished | visit_unconfirmed | card_declined | review_received | review_low_rating | staff_on_the_way | staff_clocked_out | staff_running_late | staff_not_on_the_way | staff_not_clocked_out | staff_clocked_in_twice | staff_schedule_request"contact" for by hand only, or the booking event that starts it.
first_booking_onlybooleanWith an event: true starts it only on a client's first booking. Omitted keeps the current choice.
activebooleantrue turns the flow on, false turns it off.
justificationstringOptional: why the business wants this. Shown to the owner with an owner-level change.
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_handbook_toolshed_sharing Keep an article out of the Toolshed, or share it again

Changes data

Excludes one handbook article from Toolshed sharing (its shared rules are withdrawn) or includes it again, as the article's Toolshed sharing line does. Shared rules are generalized so no one can tell which business they came from. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
sopId requiredstring
excluded requiredboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

set_lead_outcome Record a lead's outcome

Changes dataLeaves Sergio

Records what happened with a lead, as the lead card's Close menu and taps do. tap: quoted (they have a price); booked (closes it won, on the booking when one for them exists, else on your word); confirmed_booked (the same as booked); call_back_on (date YYYY-MM-DD, or at as an ISO time: pauses the lead until then; the pause ends by itself on that date, when a message goes either way, or when a step's date is changed); not_interested (lost; lostReason is one of "Timing / availability", "Price", "Went elsewhere / not needed", "Out of scope / area", or their own words for Other; a lead that just went quiet is not lost, it goes cold on its own); keep_pursuing; acknowledge_reply (their last message needs no answer: follow-ups resume); tracked_by_mistake; dismiss_plan; replied_on_site (stepKey: the Reply step answered on a lead site); undo_close (reopens a lead Sergio closed on its own, so the same evidence never closes it again; a contact made not-a-lead becomes a lead again, and Quo follows when the business's write setting allows). Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
task_id requiredstring
tap requiredquoted | booked | confirmed_booked | call_back_on | not_interested | keep_pursuing | acknowledge_reply | tracked_by_mistake | dismiss_plan | replied_on_site | undo_close
datestring
atstring
lostReasonstring
stepKeystring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_scanner_on Turn a Scanner on or off

Changes data

Turns one of the business's Scanners on or off, as the On switch in Automations > Scanners does. A Scanner is only ever on or off (never a trial mode). scanner_id comes from read('scanners'). Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
scanner_id requiredstring
enabled requiredboolean
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

set_staff_availability Set a field worker's availability for a date

Changes data

Sets one field worker's availability for a date, or a date range (end_date, up to 92 days): a day off (day_off: true), one shift (available_from + available_until, HH:MM), or split shifts (windows). It replaces that day's override; hours equal to the weekly default clear it. Nothing is sent to anyone. Returns the override ids and any booking conflicts the change creates, for a person to resolve. Pass the same idempotency_key when retrying; a repeat returns the original override ids.

InputTypeWhat it is
cleaner_name requiredstring
date requiredstring
end_datestring
day_offboolean
available_fromstring
available_untilstring
windowsobject[]
reasonstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

set_staff_weekly_hours Save a field worker's weekly hours or details

Changes data

Replaces the regular weekly hours of the workers named in staffNames with exactly the windows in entries (day_of_week 0 = Sunday to 6 = Saturday, HH:MM times; several windows a day allowed; a named worker with no entries has no regular hours). Workers not in staffNames are untouched. Omit entries to leave hours alone and only save profiles (the worker's details: email, phone, allergies, and venmo / zelle, which change only for a seat allowed to change payment handles). For one date only, use set_staff_availability. If the new hours no longer cover a worker's upcoming Sergio visits, those visits are released and a task is filed for a person. Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
staffNames requiredstring[]
entriesobject[]
profilesobject[]
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

skip_task Dismiss a task as not needed

Changes data

Dismisses a task as not needed (terminal, distinct from done). A client check-in needs a skip_reason. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
skip_reason requiredstring
notestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

snooze_conversation Mute a conversation for a few minutes

Changes data

Mutes a conversation until snoozed_until (ISO 8601, in the future), at most 10 minutes from now (a later time is cut to 10 minutes), as the inbox's Mute does while someone is on a call. note is optional. For a later follow-up, use set_conversation_reminder. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
snoozed_until requiredstring
notestring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

snooze_task Move a task's due time

Changes data

Moves a task's due time (ISO 8601 with offset). A flow-step task shifts its later steps by the same gap, as in the app. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
due_date requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

start_campaign Start a campaign (after your person confirms)

Changes dataTwo-step confirmLeaves Sergio

Starts a draft or paused campaign on your person's order, as Start campaign does: it enrolls the people waiting and drafts their first message; starting sends nothing by itself. First call without confirm_token: nothing changes; you get a preview (every message's exact words, how many people it reaches now, the audience rules, and whether the business's Sending lets a person's messages go out) and a confirm_token. Show your person the preview word for word, and only after they say yes, call again with the same arguments and the SAME idempotency_key, plus confirm_token. If the preview says Sending is switched off, tell your person that plainly with the link; only the owner turns it on, in Sergio, and you never change it. A campaign with a message Sergio sends on its own is the owner's to start, in the app. To send the drafted messages once it has started, use send_campaign_messages.

InputTypeWhat it is
campaign_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
confirm_tokenstringFrom the preview, after your person said yes. Leave it out to get the preview.

start_conversation_flow Start a flow on a conversation

Changes data

Starts a flow on a conversation, as the thread's flow picker does: flowId names an active flow (read entity flows); its steps become tasks with deadlines. label is optional. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
flowId requiredstring
labelstring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

start_group_text Open a group text thread

Changes data

Opens the one group text thread for 2 to 9 contacts who each have a phone, as the inbox's New conversation with several people checked does (an existing group for the same people is reused). Nothing is sent; texting it is send_conversational_message, which shows your person the words first. Pass the same idempotency_key when retrying.

InputTypeWhat it is
clientIds requiredstring[]
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

start_history_import Import message history from a connected inbox

Changes data

Starts importing the past messages of a connected inbox into Sergio, as Import history on Data sources does: source openphone (Quo) or gmail, or transcripts; days back (default 90). The account must already be connected (connecting is the owner's, in Settings). A second start while one is running returns that job; it carries on in the background. Nothing is sent. Pass the same idempotency_key when retrying.

InputTypeWhat it is
source requiredstring
daysinteger
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

start_spreadsheet_import Start an uploaded spreadsheet's import

Changes data

Starts the import of a spreadsheet uploaded with upload_spreadsheet, as Start in the import drawer does: Sergio checks its columns; a confident mapping imports, an uncertain one answers status needs_review and waits for review_import_mapping. Pass the same idempotency_key when retrying.

InputTypeWhat it is
jobId requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

track_conversation_as_lead Track a conversation as a new lead

Changes data

Opens a lead for this thread's contact, as the thread header's Track this as a new lead does, for a customer asking about new work. request is what they asked for, in a line. Refused when lead follow-up is off, the thread has no contact, or the contact is staff, an applicant or spam. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
requeststring
channelsms | call | email | web_chat
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

unsnooze_conversation Unmute a conversation

Changes data

Ends a conversation's mute now, as the inbox's Unmute does. Pass the same idempotency_key when retrying.

InputTypeWhat it is
conversation_id requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

update_payroll_settings Change payroll settings

Changes data

Changes one payroll setting per call, as Payroll settings on the staff page does: providerPayFallbackPct (0 to 1), providerPayDefault ({ unit: visit or hour, cents }), or payHoursFrom (booked or approved_time_logs). Staff pay settings only; no money moves. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
providerPayFallbackPctnumber
providerPayDefaultobject
payHoursFrombooked | approved_time_logs
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

update_settings Change organization settings

Changes data

Changes one or more of the organization's settings, as a person on the Settings page would, with this seat's role deciding what it may change. Sending controls, anything that opens a page to the public, payments, spend increases, and access are never available to agents. Owner-level and confirm-level settings are available when the owner turned on "Let this agent change owner settings" for this seat on the Team page (on by default for an agent the owner adds); the owner is told about each such change, with your justification if you give one. Pass changes as { "<setting key>": value }. Keys: notification_settings.enabled (toggle); notification_settings.rules (editor); settings.booking_platforms (list); urgency_settings.do_now_lead_minutes (number); urgency_settings.task_lookahead_days (number); org.chime_enabled (toggle); settings.reply_chime.delayMinutes (number); settings.reply_chime.repeatSeconds (number); settings.reply_chime.muteMinutes (number); settings.schedule.view (enum); settings.schedule.startHour (number); settings.schedule.weekStart (enum); settings.holiday_behavior (enum); settings.holiday_audience (enum); org_holidays (list); settings.field_schedule_requests_enabled (toggle); settings.field_self_block (toggle); platform_email_rules (list); settings.review_alert_at_or_below (number); blocked_senders (list); auto_assignment_config.enabled (toggle); auto_assignment_config.pool (list); auto_assignment_config.auto_classify_flows (toggle); settings.holidays_enabled (toggle, null resets it); booking_settings.policies.clock.autoClockOut (toggle); booking_settings.policies.clock.signatureRequired (toggle); booking_settings.policies.clock.geofenceRadiusHighM (number); booking_settings.policies.clock.geofenceRadiusMediumM (number); booking_settings.policies.clock.geofenceRadiusFallbackM (number); booking_settings.policies.notifications.cleanerMessageMode (enum); settings.persona_name (text, null resets it); settings.hand_sent_text_signoff (toggle); settings.crisis_resources (text); settings.price_quote_style (enum); tone_settings.preset (enum); tone_settings.customPrompt (text); org_preferences (editor); settings.notification_admin_phone (text, null resets it); settings.notification_admin_email (text, null resets it); settings.checks.callback_enabled (toggle); settings.checks.callback_minutes (number); settings.checks.close_on_activity (toggle). Editor-owned keys run one operation on that editor's own save, sent alone in its own call; read the current value first with read("settings",{area:"<that key>"}): notification_settings.rules = { op, id?, body? } with op one of: set_destinations ({ edit: "destinations", alerts?: string[] (keys from grouped.catalog), groups?: ("waiting"|"wrong"|"decide"|"fyi")[], destinations: list } sets EXACTLY these destinations for the named alerts and groups; every other alert keeps its own. A destination is { channel: "discord", target_type: "channel", channel_id } (an id from channels), { channel: "discord", target_type: "user", user_id }, { channel: "sms" }, { channel: "push" } or { channel: "webhook" }); set_in_sergio ({ edit: "in_sergio", groups: ("waiting"|"wrong"|"decide"|"fyi")[], value: boolean } shows (or stops showing) every alert of those groups in Sergio); org_holidays = { op, id?, body? } with op one of: add ({ date: "YYYY-MM-DD", label?: string, recurringAnnual?: boolean } (re-adding a date updates it)); remove ({ id } (the holiday id from the read)); platform_email_rules = { op, id?, body? } with op one of: add ({ name, sender_pattern?, subject_pattern?, source_label?, is_active?, priority?, extract_*?: boolean } (one of sender_pattern / subject_pattern)); update (id = the rule id; body = the fields to change, as in add); remove (id = the rule id; no body); blocked_senders = { op, id?, body? } with op one of: add ({ email_pattern: string (an address or *@domain), reason?: string }); remove (id = the blocked sender id; no body); org_preferences = { op, id?, body? } with op one of: add ({ text: string } (one plain-English rule) or { kind, statement, priority?, params? }); update ({ id, statement?, priority?, active?: boolean, kind?, params? }); remove (id = the rule id; no body). Pass the same idempotency_key when retrying; a repeat returns the original result.

InputTypeWhat it is
changes requiredobjectSetting key -> new value. Send only the keys that change.
justificationstringOptional: why the business wants this change. Shown to the owner in the notice Sergio sends after an owner-level change.
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

update_task Edit a task

Changes data

Edits a task as a person can on its row: title, description (details), due_date (ISO 8601 with offset, or null to clear), priority, client_id or conversation_id (null unlinks). Send only the fields to change. A flow-step task shifts its later steps when its due time moves, as in the app. Pass the same idempotency_key when retrying; a repeat returns the task, reports what the original call applied, and changes nothing if the task changed since.

InputTypeWhat it is
task_id requiredstring
titlestring
descriptionstring | null
due_datestring | null
prioritylow | medium | high | urgent
client_idstring | null
conversation_idstring | null
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.

upload_spreadsheet Upload a spreadsheet to import

Changes data

Uploads a bookings or clients spreadsheet (CSV text) and queues its import, as Upload on the Imports page does; nothing is written to customers until its columns are checked. source is the import source spelling, not a free label: a booking platform's key for its bookings export (for example bookingkoala), that key plus -clients for its clients export (for example bookingkoala-clients), or spreadsheet / spreadsheet-clients for a generic spreadsheet export. read('data_sources') names this business's platform. Returns jobId. Pass the same idempotency_key when retrying. An owner-level change: Sergio tells the owner after it is made.

InputTypeWhat it is
source requiredstring
csv requiredstring
idempotency_key requiredstringYour id for this operation (8-128 of A-Z a-z 0-9 . _ : -). Reuse it on every retry of the same operation; use a new one for a new operation.
reasonstringWhy you are doing this, in one sentence. The owner sees it in the notice Sergio sends after the change.

Feedback

Tell the Sergio team something is missing or wrong.

report_feedback Report a bug or idea to the Sergio team

Changes data

Files a bug report or feature request with the Sergio team. It lands in the team's one Feedback inbox, the same place the in-app help bubble's reports go, tagged with this agent seat, and the team is notified the moment it is filed. There is no other feedback channel to try. Check with your user first unless they have already told you that you may report without asking; afterwards, tell your user in one line what you sent. Never include passwords, API keys, or card numbers.

InputTypeWhat it is
kind requiredbug | feature_request
description requiredstring
pageUrlstring
sergio

Customer operations software for residential cleaning companies.

Product

Customer workspaceCampaignsWhy SergioCertificationsSergio MCPFor buildersFAQ

Works with

BookingKoalaConvertLabsLaunch27QuoGmail

Company

Log inBook a demoContactReferral partnersBlogServicheShowcasePrivacyTerms
© 2026 Serviche. Sergio is customer operations software for residential cleaning companies.
G2 Reviews on G2P Product Hunt