Run Famulor AI phone assistants: start calls, manage campaigns, leads, contacts, knowledge and bookings, read conversation history and send SMS.
Explore 84 workflow actions for Famulor, including account permissions and operation limits.
51 read actions33 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add leads
Write
Adds one lead (body = a single lead object; data in the response is the created lead) or many (body = an array of lead objects, max 1000; data is the array of created leads and.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add suppression entry
Write
Records a marketing opt-out for a contact identified by contact ID, phone, or email.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign leads to campaign
Write
Assign leads to a campaign from a saved segment (segment_id) OR explicit lead_ids; provide exactly one.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel booking
Write
Cancel a confirmed booking.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel scheduled callback
Write
Cancels a pending or dialing callback so it will not be dialed.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create assistant
Write
Creates an assistant.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create audience contact
Write
Create an unassigned Audience contact, or merge user-defined tags and missing identity fields into an existing contact with the same phone or email.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create booking
Write
Book a free start time of an event type for an invitee.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create call
Write
Places an outbound call: the assistant must be active and needs an outbound-capable phone number (assigned to it, or passed via phone_number_id).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create campaign
Write
Creates a campaign in status draft.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create knowledge base
Write
Creates an empty knowledge base.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create knowledge base faq
Write
Creates human-approved FAQ knowledge and indexes it immediately.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create segment
Write
Save a lead filter as a reusable segment.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete assistant
Write
Deletes the assistant permanently.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete campaign
Write
Deletes the campaign.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete knowledge base
Write
Deletes the knowledge base including all its documents and chunks.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete knowledge base document
Write
Deletes one knowledge-base document together with its indexed chunks and its stored original file.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete knowledge base faq
Write
Delete an FAQ entry.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lead
Write
Removes the lead from campaign execution while retaining the Audience contact, calls, and completed campaign history.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete segment
Write
Delete a segment.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get assistant
Read
Required scope: assistants:read (keys without scope restrictions have full access).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get assistant tools
Read
List assigned central tools.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get assistant variables
Read
Returns the custom variable definitions of an assistant plus the inbound variable webhook URL.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get automation run
Read
One automation run with its step log: every executed step's action, status, input (the step's configuration as saved, before templates are filled in), output, error and timing.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get balance
Read
Minutes and credits balance of the API key's workspace plus a summary of its active plan.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get booking
Read
Read a single booking.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get booking event type
Read
Read a single event type.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get call
Read
Call details including the transcript, the AI summary, provider-neutral failure guidance, the chronological event log, and a signed recording_url (valid 1 hour) if a recording.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get campaign
Read
Campaign details including total_leads.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get campaign stats
Read
Progress and performance aggregates for a campaign: total and completed leads, calls made, total call duration, and delivery attempts by outcome.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get email history item
Read
Returns every inbound and outbound turn in the email thread in chronological order, including stable thread and immediate-parent IDs, full plain-text bodies, reply.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get knowledge base
Read
Required scope: knowledge:read (keys without scope restrictions have full access).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get knowledge base faq
Read
Get an FAQ entry.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get lead
Read
Returns editable contact data and user-managed custom_fields plus a separate read-only system_variables object.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get me
Read
Self-inspection of the calling API key: key metadata, workspace (tenant), active plan, effective limits, feature toggles, and Assistant engine-mode availability (-1 = unlimited.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get messaging history item
Read
Returns up to 500 messages in chronological order with full text, attachment metadata, available voice-note transcripts, short image descriptions, and media links valid for one.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get phone number
Read
Required scope: phone_numbers:read (keys without scope restrictions have full access).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get segment
Read
Read a single segment.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get tool
Read
Read a single reusable tool.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Get workspace usage rates
Read
Current customer credit rates for the credential workspace, including fixed charges, token-based AI usage and variable charges.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List assistant versions
Read
Required scope: assistants:read.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List assistants
Read
Paginated list of assistants in your workspace, newest first.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List audience contact channels
Read
List the manually manageable channel profiles linked to one Audience contact.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List audience contacts
Read
List contacts across all campaigns with channel and tenant-scoped Call QA filters.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List automation runs
Read
Runs of one automation, newest first: status, trigger event, error, timing and credits.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List automations
Read
Returns native workspace automations plus platform entitlement/run allowance.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List booking event types
Read
List the event types of the native booking engine.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List booking slots
Read
List the free start times of one active event type for a date range (at most 28 days; dates default to the workspace time zone).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List bookings
Read
List bookings of the native booking engine.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List calls
Read
Calls in your workspace, newest first by creation time unless sort=updated_at is set.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List campaign deliveries
Read
Lists primary and follow-up delivery attempts.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List campaigns
Read
Required scope: campaigns:read (keys without scope restrictions have full access).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List history
Read
Calls and assistant email conversations in your workspace, globally sorted by latest activity.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List knowledge base documents
Read
Lists the documents of one knowledge base, newest first: uploaded files, raw text, file URLs, single web pages, crawled website pages and cloud drive files.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List knowledge base faqs
Read
Lists approved FAQ entries or the human-review knowledge-gap inbox.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List knowledge bases
Read
Required scope: knowledge:read (keys without scope restrictions have full access).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List languages
Read
The platform's assistant language catalog (ISO 639-1 or ISO 639-3 codes with English labels), managed by the platform admin.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List leads
Read
Leads of a campaign, newest first.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List models
Read
Requires the active workspace AI Safety & Control entitlement in addition to assistants:read.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List phone numbers
Read
Phone numbers of your workspace, newest first.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List scheduled callbacks
Read
Callbacks booked by the Schedule callback tool across voice, chat/messaging, and email.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List segment leads
Read
Leads currently matching the segment's saved filters, newest first, paginated.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List segments
Read
List all segments (saved, dynamic lead filters) of the workspace.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List suppression entries
Read
Lists active marketing suppressions across voice, SMS, email, and supported messaging channels.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List tools
Read
List the central API, MCP, and built-in Tool Registry.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List transactions
Read
Workspace balance ledger, newest first.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List variable sources
Read
Lists system variables, workspace lead attributes, and assistant variables available for campaign and WhatsApp template mappings.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List voices
Read
Complete paginated voice library for the active workspace.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
List whats app templates
Read
List HSM templates for the workspace.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Lookup bookings
Read
Finds confirmed future bookings of the workspace by invitee identity - the same identity check assistants use before rescheduling or cancelling.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Remove suppression entry
Write
Revokes one active suppression and appends an opt-in audit event; compliance history is not erased.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reply to history conversation
Write
Send a human reply to an email or messaging conversation and pause AI replies.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reschedule booking
Write
Moves a confirmed booking to a new start time.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search knowledge base
Read
Search document excerpts and exact table values with original cells and sources.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
Send sms
Write
Send an outbound SMS from a workspace phone number that has outbound SMS enabled (platform marketplace or Twilio BYOC).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start campaign
Write
Sets the campaign to running and triggers the first dialer wave immediately; subsequent waves run on a schedule.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stop campaign
Write
Pauses a running campaign (status paused).
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Trigger automation
Write
Manually start a run for the automation.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update assistant
Write
Partial update - only the provided fields change.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update assistant variables
Write
Replaces the custom variable definitions, contact-field access mode, and/or the inbound variable webhook URL.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update campaign
Write
Updates name, assistant and/or dialer settings.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update knowledge base faq
Write
Approval requires an answer and publishes it to retrieval.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update lead
Write
Updates name, phone, email, tags, or user-managed custom fields.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update segment
Write
Partial update - only the provided fields change.
Permissions and limits
Account permissions
A Famulor workspace API key with the step's scope
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Famulor. A saved workflow is not a completed provider action.