FavCRM

Search and filter members/accounts. Supports text search, date ranges, booking/activity history, membership tier, tags, and more. Use lastBookingBefore/inactiveDays to find inactive members.

Get detailed profile for a specific member/account by ID.

Preview a bulk customer import (max 2000 rows). Matches existing accounts by phone/email and shows create vs update actions plus points/stamps/credit deltas. Use commit_customer_import with the returned sessionId to apply.

Commit a previewed customer import. Pass the same rows and sessionId returned by preview_customer_import. Creates/updates accounts and applies points, stamps, and credit deltas.

Create a CRM account/customer with a primary contact. Optionally enroll the account as a member; use enrol_membership later when the account already exists.

Update CRM account/customer profile fields such as name, phone, email, life stage, owner, notes, or member code.

Soft-delete a CRM account/customer. This releases the primary phone for future reuse while keeping account history for audit.

List all available tags for the merchant.

Create a CRM tag for customer segmentation and organization.

Rename or recolor an existing CRM tag.

Delete a CRM tag and remove it from all tagged entities.

Attach one or more tags to a member/account. Useful for segmenting members after filtering.

Detach one tag from one or more member/account records.

List all membership tiers with member counts and stats.

Get a specific membership tier by ID.

Issue a gift/reward to multiple members. Requires a gift offer ID and member IDs.

Enrol a member into a membership tier. Free tiers enrol immediately; paid tiers return PAYMENT_REQUIRED unless skipPriceCheck is set. Use list_tiers first to find the target tier.

Get a member's current loyalty balance — points, stamps, credits, lifetime totals, and active membership tier. Returns null if the member is not enrolled.

Credit loyalty points or stamps to a member. Use field="points" for points, "stamps" for stamps. Server records a transaction with the reason as audit context.

Get high-level business KPIs: member count, new members this week, active subscriptions, total points issued, active promotions, rewards redeemed, messages sent.

List bookings with filters for date range, status, service, staff, or member.

Get full booking details including line items, status history, and participants.

Get booking counts: today, this week, this month, and breakdown by status.

Find available booking slots for a service on a specific date.

List booking services with name, price, duration, and status.

Get full service details including addons, staff, resources, and tier pricing.

Read every membership-tier pricing configuration for one booking service.

Set the complete pricing and booking-policy configuration for one membership tier on a booking service.

Copy the complete pricing and booking-policy configuration from one membership tier to another on the same booking service.

Create a bookable service. Sets duration, price, capacity, and policies. Use list_service_categories first if you want to attach to an existing category.

Update an existing booking service. Pass only the fields you want to change.

Create a bookable schedule window for a service, including recurring weekly/daily availability.

List schedule windows for booking services.

Update a service schedule window. Pass only fields to change.

Assign a staff member to a booking service. Pass users.id from list_staff.userId.

Link a room/resource to a booking service.

List service categories (groups for booking services like "Treatments", "Classes").

Create a service category (e.g. "Treatments", "Classes") to group bookable services.

Create a bookable resource (room, equipment, vehicle). Used by services that have requiresResource=true.

Add an availability window for a resource. Use day-of-week + recurring=true for weekly schedules, or a specific date for one-off blocks.

Add an availability window for a staff member (companyMembers.id). Use day-of-week + recurring for weekly schedules, or a specific date for one-off changes.

Get global booking settings for the customer booking flow, cancellation rules, visibility options, and confirmation requirements.

Update global booking settings. Pass only the fields you want to change.

List support tickets with optional filters.

Get ticket counts grouped by status.

Create a support ticket for a member issue.

Update the status of an existing support ticket.

List surveys with optional status/search filters.

Create a survey with custom question blocks. Publish it later or set status to published for immediate portal access.

Get survey detail, including blocks, publishing status, visibility, settings, and response count.

Update a survey draft or publishing configuration. Use questionBlocks to replace the ordered form block list.

Archive a survey and remove it from active survey lists.

Get response and invitation metrics for a survey overview dashboard.

List responses for a survey.

List survey invitation history without exposing token hashes or old invitation tokens.

Create a token-auth survey invitation for a specific member/account or contact.

List automation workflows attached to a survey.

Create or update a survey automation workflow, usually triggered by survey_response_submitted.

List CRM deals (sales pipeline) with optional filters.

Get detailed CRM deal information by ID.

Create a CRM sales pipeline deal, optionally linked to a customer account and contact.

Update a CRM deal. Pass only fields to change; use null for nullable links/fields to clear them.

Soft-delete a CRM deal from the sales pipeline.

Move a deal to a different pipeline stage.

Mark a CRM deal as won and set close date.

Mark a CRM deal as lost. Requires a lost reason.

Convert an account: qualify its open lead (creating one if needed) and link exactly one pipeline deal. Also promotes lifeStage lead -> active. Safe to repeat — a second call lands on the same lead and deal. Works on accounts that are already active.

List contacts (people linked to CRM accounts), optionally filtered by account or search.

Fetch a single contact by ID.

Create a contact on an existing CRM account.

Update fields on an existing contact.

Set a contact as the primary contact for its CRM account and demote other contacts on that account.

Delete a secondary contact. Primary contacts are protected; set another primary contact or delete the account instead.

List custom field definitions for CRM entities such as account, contact, deal, or booking.

Get a custom field definition by ID.

Create a custom field definition for CRM entities. Use options for select or multiselect fields.

Update a custom field definition label, type, options, required flag, or sort order.

Delete a custom field definition and its stored values.

Get custom field values for a CRM entity such as an account, contact, deal, or booking.

Set or clear custom field values for a CRM entity. Values are stored as strings; pass null to clear a value.

List tasks with optional status, assignee, and account filters.

Get detailed task information by ID.

Create a task. Optionally link to a CRM account or assign to a team member.

Update a task (status, priority, assignee, due date, completion).

Soft-delete a CRM task.

Search across CRM accounts and contacts by name, email, or phone.

List invoices with optional filters. Use status "OVERDUE" to find unpaid invoices past due date.

Fetch a single invoice with line items, payment history, and customer detail.

Create a new invoice for a customer. Optionally include line items inline. Returns the new invoiceId.

Record a manual payment against an invoice (cash, bank transfer, cheque, card terminal). Updates invoice status to PARTIAL or PAID based on the running total.

Mark an invoice as sent to the customer (transitions DRAFT → OPEN). Use after delivering the invoice via email or share link. Idempotent.

Void an invoice. Destructive — invoice can no longer be paid or edited; existing payments are preserved as history. Cannot void invoices that are already PAID or VOIDED.

Delete a DRAFT invoice. Only invoices that have never been sent can be deleted; otherwise use void_invoice.

Restore a previously deleted DRAFT invoice.

Outstanding totals, overdue counts, and revenue this period. Used by the weekly-snapshot playbook.

List registrations for an event in the active company, including CRM account IDs for campaign exclusions.

Resolve pending, confirmed, and paid event registrations into unique CRM account IDs for campaign exclusions. Pass accountIds to audienceExclusions only when ready=true; cancelled registrations are omitted and unmatched guests make the result not ready.

List member subscriptions. Filter by status to find active, cancelled, or past-due subscriptions.

Fetch a single subscription with customer, tier, billing cycle, and renewal info.

Create a manual, non-renewing subscription record for a member. Use a subscription action link for provider-backed recurring billing.

Pause an active subscription (status → past_due, no further auto-renew). Use resume_subscription to reactivate.

Resume a paused subscription back to active.

Cancel a subscription. Destructive — turns off auto-renew and prevents further billing cycles. Existing paid periods stay valid until end.

List marketing campaigns (email, SMS, WhatsApp, or push) with delivery stats. Use the returned IDs when excluding recipients of previous campaigns.

Get a campaign by ID, including its recipient source, audience exclusions, channel configuration, and delivery stats.

Create an email, SMS, WhatsApp, or push campaign in DRAFT. audienceExclusions can omit specific account IDs and recipients of previous campaign IDs. For email channelConfig, use subject + htmlBody + optional plainTextBody. recipientSource="list" is accepted as an alias for "individual".

Update an existing campaign, including audience exclusions. Channel cannot be changed after creation. Pass only fields to change.

Delete a campaign. Only allowed in DRAFT status; sent campaigns are kept for audit history.

Restore a previously deleted campaign.

Undo a campaign send during its one-minute safety buffer. Use immediately when the merchant says to stop or undo a submitted campaign.

Validate a campaign before sending. Resolves contactable recipient count and previews the final email subject/body without sending.

List notification delivery logs for the current company. Recipients are masked by default for incident-response safety.

List messaging conversations across WhatsApp, Messenger, Instagram, Threads, SMS, email, and other enabled channels. Threads items are public conversations. Shows unread counts and last message time.

List recent audit log entries for this company. Filter by action, resource, resourceId, user, source, outcome, destructive flag, and created date range.

Search audit logs by free text across action, resource, resource ID, changes JSON, and metadata JSON.

Fetch a single audit log entry by ID, including before/after snapshots when available.

Revert an audited action by restoring the captured before snapshot. Only works for allowlisted target tables with full before/after audit snapshots.

Duplicate an existing record (product, tier, campaign, post, service package, promotion, gift offer). Creates a copy in DRAFT status with "(Copy)" appended to the name.

List notes attached to a member/account, booking, or ticket.

Add a note to a member/account, booking, ticket, or invoice.

Confirm a pending booking.

Cancel a booking and create a durable refund receipt. Uses the merchant refund setting unless refundMethod is provided.

Mark a booking as completed. Triggers commission calculation if configured.

Mark a booking as no-show when the customer did not attend.

List promotion/coupon codes with optional status filter.

Get details of a specific promotion/coupon code.

Create a promotion / discount code. type=percentage or fixed_amount; value is the discount as a string ("10" = 10% or 10 currency units). Codes are uppercased server-side.

Update an existing promotion. Pass only the fields you want to change.

Delete a promotion. Past usage records are preserved.

Restore a previously deleted promotion.

Check if a promotion code is valid for a given order. Returns isValid, discount amount, and an error code/message if invalid. Use before applying to a checkout.

List loyalty reward schemes (points/stamps programs) configured for this business.

List staff/team members in the business.

List booking resources (rooms, equipment, etc.).

List service packages/prepaid session bundles with optional search, status, sorting, and pagination.

Get service package detail including applicability and selected booking service/event items.

Create a service package/prepaid session bundle. Use applicableType=SELECTED with applicableItems to limit the package to specific booking services or events.

Update an existing service package. Pass only the fields you want to change.

Delete a service package by ID.

Restore a previously deleted service package by ID.

Show the current organisation plan, subscription/payment state, enabled modules, and quota usage. Use before deciding whether an agentic operation is allowed.

Preflight whether an intended operation is allowed by token scopes, enabled modules, subscription state, and quota. Provide toolName, quotaCode, or moduleCode.

List active FavCRM plans with prices, quotas, included modules, and whether each is the current plan.

Create a Stripe Checkout link for a new paid subscription, or a Stripe Billing Portal link for an existing Stripe subscription. Use only after the user explicitly asks to upgrade or fix billing.

Invite a team member to this company and return a one-time MCP accept token. The invited user must verify an email code through accept_team_invite_request and accept_team_invite_verify before membership and API key issuance.

Step 1 of agentic team invite acceptance. Validates an invite token and sends a 6-digit verification code to the invited email. Then call accept_team_invite_verify with the code to join and receive an MCP API key.

Step 2 of agentic team invite acceptance. Verifies the emailed code, joins the invited user to the company, and returns a one-time MCP API key for that user.

Check whether WhatsApp Business is connected for this company, including WABA/phone metadata and the latest agentic connect session state.

Create a short-lived browser link for WhatsApp Business Embedded Signup. The user must open the link because Meta requires a browser popup to authorize and choose the WABA/phone number.

List all companies/organisations the current user has access to. Use this to see available orgs before switching.

Issue a new MCP access token scoped to another company/organisation. This does not mutate the current MCP connection: the client must use the returned token on later /mcp requests. Platform operators should prefer explicit-company admin tools when available.

List CMS posts (blog posts and/or pages) with optional filters.

Get detailed CMS post including content blocks, categories, and tags.

Create a new CMS post (blog_post, page, or any custom post type). The post type must already exist — use list_post_types to discover, create_post_type to add a new one. excerpt = plain-text summary only (auto-derived from blocks if omitted). Structured custom fields go in meta, keyed by the field schema defined with create_post_type_field.

Update an existing CMS post (any post type). Only provided fields are changed.

Delete a CMS post by ID. Soft-deleted posts can be restored with restore_post.

Restore a previously deleted CMS post.

List AI image-generation models exposed to merchants (sanitized — provider/cost details hidden). Use to pick a `modelCode` for `generate_post_cover`.

Generate an AI image via kie.ai and return its public R2 URL. Use to mint reusable URLs for content blocks (image, gallery), product photos, or any field that takes an image URL — does NOT attach to a post by itself. Costs credits (see list_image_models). On poll timeout the job continues running; pass `jobId` from the response to merchant ai-media APIs to retrieve it later.

Generate an AI image and attach it as a post's featuredImage. Submits a kie.ai job, polls until complete, copies the result into the canonical post-asset R2 folder, and writes the public URL onto the post. Costs credits (see list_image_models). On poll timeout, the job continues — call attach_post_cover_from_job(postId, jobId) once it finishes to attach without paying again.

Attach a previously generated ai-media job's output as the post's featuredImage. Use when generate_post_cover timed out (job kept running) or when reusing the same generation across multiple posts. Verifies the job belongs to your company and succeeded. Does NOT charge credits — credits were charged at submit time.

Download an external image URL into R2 and attach it as the post's featuredImage. Replaces the manual flow of pasting external URLs (which break when the source goes down). Validates content-type starts with `image/` and rejects payloads larger than 20 MB. No AI credits charged — only standard storage.

List CMS post categories.

Create a CMS post category (e.g. "Equipment", "Injection — Botox"). For sub-categories, use namespaced names — the table is flat.

Update a CMS post category.

Delete a CMS post category. Posts in the category are not deleted; they are simply unlinked.

Restore a previously deleted CMS post category.

List all post types defined for this company (built-in: blog_post, page; plus any custom types).

Define a new custom post type (e.g. "treatment", "service"). Required before creating posts of that type. After creating a post type, use create_post_type_field to define its structured field schema. Those fields are stored in meta on each post — do not use excerpt for structured data.

List the custom field schema for a post type. Use this before creating posts to know which keys to pass in meta and what types they expect.

Add a custom field to a post type schema. The field key becomes the key in meta when creating/updating posts. Use fieldType="repeater" with fields=[...] for repeatable structured rows. Use this instead of storing structured data in excerpt.

Update a custom post type. Built-in types (blog_post, page) cannot be modified.

Delete a custom post type. Built-in types cannot be deleted. Fails if any posts of this type still exist — delete those first.

Restore a previously deleted custom post type.

Update a field on a post type schema. Changing fieldType or flipping required=true is blocked when posts already use the field unless force=true is passed.

Remove a field from a post type schema. Blocked when posts of this type still have data in the field unless force=true is passed (orphans the data).

Restore a previously deleted field on a post type schema.

Reorder fields on a post type. Pass field IDs in the desired display order; sortOrder is updated to match.

Append one or more blocks to the end of a post. Each block must be a valid block object: { id, version, type, data }. Types: paragraph, heading, image, list, quote, code, divider, spacer, embed, html, youtube, file, faq, callout, gallery, cta, accordion, product.

Replace a single block at the given index (0-based). Avoids fetching the full post and re-sending all blocks via update_post.

Remove the block at the given index (0-based). All subsequent blocks shift up by one.

Reorder blocks by passing block IDs in the desired order. The id list must contain every existing block id exactly once.

Create a new booking for a member. Use get_available_slots first to find valid times, then create the booking with the service, member, date, and time.

Get messages from a specific conversation thread. Shows the chat history between the merchant and a contact.

Find or create a Workroom DM thread between a merchant user and an AI colleague. Use this when an inbound event deserves owner attention but no threadId was provided. This only prepares an internal Workroom channel.

Read the text/Markdown content of a file attached to a Workroom thread or sent by a customer (PDF, image, or document). Extracts on first read and caches the result. Returns status "ready" with markdown, or "skipped"/"failed"/"not_found" with a reason. Use when a message references an attachment you need to read.

Post an internal message from an AI colleague into a Workroom thread. Use this to report findings, ask the owner for approval, or share source links after reading CRM/Inbox data. This does not send anything to customers.

Create a draft reply suggestion that appears inline in the FavCRM Inbox composer. Use this for message.inbound events with replyPolicy="suggest"; it does not send anything to the customer.

Create a merchant-owned Workroom approval request for a customer-facing send. The agent must not call send_message, send_whatsapp_message, send_test_campaign, or send_campaign directly.

List customer segments. Segments group members by criteria for targeted campaigns.

Get customer segment details including type, criteria, and live member count.

Get the members that belong to a specific segment.

Create a new customer segment. Use STATIC for manual member lists, DYNAMIC for criteria-based auto-filtering.

Update an existing customer segment by id. Pass only the fields to change; criteria replaces the existing rules.

Preview how many customers would match dynamic segment criteria before creating or updating a segment.

Replace the members of a STATIC customer segment with the given account IDs. The segment is converted to STATIC.

Delete a customer segment.

List the company's WhatsApp message templates with their Meta approval status (PENDING / APPROVED / REJECTED). Check this to see which templates are approved before referencing one in a campaign.

Create and submit a WhatsApp message template to Meta for approval. Text templates only (header text, body with {{1}} variables, footer) — add buttons in the app. The template is NOT usable until Meta approves it (check with list_templates). Submitting consumes the store’s Meta template allowance.

List shop outlets/locations for the company.