1. Docs
2. /
3. Tool reference
4. /
5. Contacts & CRM

Contacts & CRM

People, contact folders, lead scouting, and drafted outreach to a contact.

82 verbs in this family.

• addChannelProperty write Add a property (a column) to one channel: a delivery date, an order total, a priority select, a checkbox.
• addContactsToFolder write Add hand-picked contacts to a manual folder (drag-in).
• addInteractionNote write Write a note on an entry.
• addProductionStage write Add a production step to a channel, at the end of its axis.
• approveFormOutreachJob writeconsentexternal Approve ONE eligible queued form-outreach job by id so it can be submitted.
• approveFormOutreachWave writeconsentexternal Approve the eligible pending jobs in one named form-outreach wave.
• approveOutreachCards write Approve outreach cards with the owner's word: by card (`cardIds`) or by wave (`wave`, an audience on the list).
• attachFormToClients write Attach a form to Clients.
• claimFormOutreachJob writeexternal Claim ONE approved form-outreach job so this session can submit it on the browser rail.
• completeFormOutreachJob write Record the outcome of a form-outreach job this session claimed with claimFormOutreachJob.
• createChannel write Create an interaction channel: a new tab in the shop's Interactions, with its own stages and properties.
• createClient write Create a client in the shop owner's client book.
• createContact write Create a new personal contact for the caller.
• createContactFolder write Create a contact folder: the campaign audience primitive (Campaign Execution Studio).
• createEntry write Create an entry in a channel: a phone order, a walk-in, an enquiry, anything the shop wants written down.
• createInteractionChannel write Create an interaction channel: a new tab in the shop's Interactions, with its own stages and properties.
• createOutreachList write Create an outreach list: the targets one message goes to, owned by you and private to you.
• deleteContact writedestructive Delete (archive) one of the caller's personal contacts by id.
• deleteEntry writedestructive Delete an entry: take it off every board, list, calendar and money total.
• detachFormFromClients write Detach a form from Clients.
• excludeFormOutreachRecipient write Record a durable contact-form exclusion for ONE pending job after a prior direct-form submission has been verified from a real receipt.
• findDuplicateClients read Find possible duplicates of one client.
• getContact read Get one of the caller's personal contacts in full by its id.
• getEntryMoney read The whole money picture of one entry: what it is expected to come to, what has been collected, what has been refunded, what is still due, and every payment link, order and invoice attached to it.
• getScoutFunnel read Read tenant-isolated outreach funnel counters for a scout run and optional tier: scanned, cards, verified, consented, send-ready, sent, and replied.
• heartbeatFormOutreachJob write Renew this session's live form-submission claim while browser work continues.
• importContacts write Import contacts either from supplied rows or from a TripleSeat contacts export in Cloud Files (a contacts export, the Accounts Report or the Accounts and Contacts Report).
• importGoogleContacts writeexternal Import the owner's Google address book straight into their contacts.
• importInteractions write Import a shop's existing book of events from an export file already in their Cloud Files, landing every row as an entry in a channel so the shop calendar shows the same weeks the old system showed.
• importOutreachTargets write Import targets into an outreach list from a JSON or CSV file: inline `content`, or a data file in one of your Studio apps (`studioApp`: appId and path).
• listChannels read List a shop's interaction channels: the tabs its CRM is organised into (orders, leads, clients, whatever the owner made): with each channel's stages in board order, its properties, and how many live…
• listClients read List clients for a personal or Space shop.
• listContactFolders read List the caller's contact folders: the audience primitive for campaigns: each with its live contact count.
• listContactImports read List the owner's contact imports, newest first: what each one was, where it came from, what it did, and whether it has been withdrawn.
• listContacts read List the caller's personal contacts: the people layer of their CRM.
• listContactSources read List the places contacts can be imported from and say which are authenticated right now.
• listDeletedEntries read What was deleted from a channel and can still be taken back, newest deletion first: with who deleted it and why.
• listEntries read List entries with the customer, the stage each sits in, and every property value.
• listFolderContacts read List the contacts a folder currently resolves to: its hand-picked members or its live rule matches.
• listFormOutreachJobs read List your queued form-outreach jobs (the ones reachOutViaForm stacked), owner-scoped and paged: each job with its contact, the form URL, status, when it was queued, its wave, and any refusal or…
• listInteractionChannels read List a shop's interaction channels: the tabs its CRM is organised into (orders, leads, clients, whatever the owner made): with each channel's stages in board order, its properties, and how many live…
• listInteractionNotes read Every note written on an entry, newest first, each with its author, when it was written, and whether it was a team note or a note to the customer.
• listInteractions read List entries with the customer, the stage each sits in, and every property value.
• listOutbound read List every message Ora sent on your behalf, on every channel, newest first: who it went to, what it said, when, the channel, the message id, the signature used, whether they have replied since, and…
• listProductionQueue read Everything sitting at one production step, optionally for one day or date window: the read a shop makes every morning ("what has to be baked today").
• listProductionStages read The production steps a channel runs its work through, in order: the shop's own words for them (empty, counted, baked, crumbed, finished; or plates, proofs, press).
• logContactTouch write Record a reply the human already posted onto a contact's touch timeline, stamped with its channel and a link to the artifact (the posted comment's URL).
• logInteraction write Create an entry in a channel: a phone order, a walk-in, an enquiry, anything the shop wants written down.
• mergeClients writedestructive Merge duplicate clients only when the user asks.
• onboardServiceProvider writeconsent Set a company up to take service requests in one call.
• previewContactImport write Show what an import would do: how many people are new, how many match a contact already in the book, which existing contact each duplicate would merge into, and the normalized rows to pass to…
• previewOutreachCard write Render outreach cards exactly as they would send: for one target (`targetId`) or every target on the list.
• pullSquareCustomers writeexternal Pull a Square Customer Directory into a contact book, from a Square export in Cloud Files or a connected Square account, with consent kept per channel.
• queueOutreachDraft writeexternal Queue ONE tailored outreach draft for one of the caller's personal contacts, into their reviewed approve-each queue.
• reachOutToContact writedestructiveexternal Reach out to ONE of the caller's personal contacts by email: a single real email from the caller's connected Gmail (it appears in their Sent and reads as from them).
• reachOutViaForm writeexternal Enqueue an outreach to a scouted lead through the contact form on THEIR website: a fleet browser-worker fills and submits the form later, and NOTHING sends until you approve the job in-app first.
• readChannelOfRecord read Read the channel a person answers on, with its evidence and, for iMessage, the chat id and the Messages box.
• readEntryGuestCounts read Read the three guest counts on one entry (expected, guaranteed, actual), each with who set it and when, and the day the guaranteed count is owed: the entry's own deadline, or the event date less the…
• readOutreachList read Read your outreach lists.
• removeContactsFromFolder write Remove contacts from a manual folder (drag-out).
• resolveContact read Resolve a person against the caller's existing personal contacts by ANY handle they carry: identity lookup and dedup, NOT messaging.
• restageContactImport write Re-file a whole import under a new category: move every contact in it to a different stage, swap the tags it applied, and rewrite its consent posture.
• restoreEntry write Put a deleted entry back exactly as it was: its stage, its dates, its history, its money, and its place on the calendar.
• scoutLeads writeexternal Scout net-new business leads via the Google Places API and land them as pending lead cards in the caller's CRM.
• scoutWebLeads writeexternal Verify live job postings, startup/lab feed entries, and storefront websites, then land deduplicated CRM cards in a pending verification queue.
• searchContacts read Search the caller's personal contacts by a single query string, matched across name, email, phone, job title, and notes.
• sendApprovedOutreach writedestructiveexternal Send an outreach list's APPROVED cards, all of them or the `cardIds` named.
• sendIMessage writedestructiveconsentexternal Send an iMessage for a person to a client's Messages chat (group or 1:1), through your own Mac signed in to Messages via MachineSync: an AppleScript send to that chat id, never typed into a browser.
• setChannelOfRecord write Record the channel a person actually answers on (imessage, email, sms, telegram, instagram, slack or x), with the evidence: the id or the date of their last inbound message there.
• setEntryGuestCounts write Set any of the three guest counts on one entry: expected (what the client first said), guaranteed (what the event is billed on, owed by the guarantee deadline), actual (how many came).
• setEntryProduction write Move one entry along the production axis: where the WORK has got to.
• setEntryTotal write Correct what an entry is expected to come to, in MINOR units of its currency (75000 = €750.00).
• setGuaranteeDeadline write Set the day an entry's guaranteed guest count is owed, and optionally the shop's lead time (days before the event) that every entry without its own day falls back to.
• setOutreachTemplate write Set the one message an outreach list sends: a subject and body with NAMED variables only, written as {first name} or {meet link}, and the list of names you declare.
• setStageRoomHold write Say whether a channel stage holds rooms.
• undoContactImport writedestructive Withdraw a whole contact import in one action.
• updateChannel write Rename an interaction channel, change its description, archive it, take it on or off the shop calendar, or rename and hide its BUILTIN columns.
• updateChannelProperty write Rename a channel property, CHANGE ITS TYPE, change its choices, reorder it, or make it required.
• updateClient write Update a client by id.
• updateContact write Update one of the caller's personal contacts by id.
• updateEntry write Edit an entry: rename it, set any property, move it to another stage, or archive it.
• verifyScoutLeads writeexternal Verify up to 25 pending scouted cards from a run or explicit contact list.