accueil / serveurs / Productivité / io.favcrm/favcrm
io.favcrm/favcrm
serveur MCP (Model Context Protocol) · favcrm 1.0.0
Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur.
Est-ce que io.favcrm/favcrm est sûr ?
Au dernier audit MCP Hub, le serveur MCP « io.favcrm/favcrm » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.
Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.
Les 237 outils
- accept_team_invite_request≈ 302 tokens
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.
Paramètres, retour & exemple (1)
Paramètrestoken· string · requis
Invite token returned by create_team_member_invite or from the invite link
Exemple d'appel{"name": "accept_team_invite_request", "arguments": {"token": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - accept_team_invite_verify≈ 350 tokens
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.
Paramètres, retour & exemple (3)
Paramètrescode· string · requis
6-digit code from the invite emailname· string · optionnel
Optional display name when creating a new usertoken· string · requis
Invite token returned by create_team_member_invite or from the invite link
Exemple d'appel{"name": "accept_team_invite_verify", "arguments": {"code": "texte", "token": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - add_knowledge_text≈ 328 tokens
Add a free-form text document to the knowledge base. Use for pasted policies, FAQs, internal notes, brand voice references — anything the agent should be able to retrieve later. Stored as a single document; agent-side embedding/retrieval happens elsewhere.
Paramètres, retour & exemple (2)
Paramètresname· string · requis
Friendly title for the documentcontent· string · requis
Document body text
Exemple d'appel{"name": "add_knowledge_text", "arguments": {"name": "texte", "content": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - append_post_block≈ 2678 tokens
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.
Paramètres, retour & exemple (2)
Paramètresblocks· array · requis
Block(s) to appendpostId· string · requis
The post ID
Exemple d'appel{"name": "append_post_block", "arguments": {"blocks": [], "postId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - archive_survey≈ 243 tokens
Archive a survey and remove it from active survey lists.
Paramètres, retour & exemple (1)
ParamètressurveyId· string · requis
Survey ID to archive
Exemple d'appel{"name": "archive_survey", "arguments": {"surveyId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - assign_staff_to_service≈ 275 tokens
Assign a staff member to a booking service. Pass users.id from list_staff.userId.
Paramètres, retour & exemple (2)
ParamètresuserId· string · requis
users.id from list_staff.userIdserviceId· string · requis
Service ID
Exemple d'appel{"name": "assign_staff_to_service", "arguments": {"userId": "texte", "serviceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - attach_post_cover_from_job≈ 465 tokens
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.
Paramètres, retour & exemple (5)
ParamètresjobId· string · requis
The ai-media job ID (from generate_image, generate_post_cover, or POST /v6/merchant/ai-media/generate)postId· string · requis
The post IDassetIndex· integer · optionnel
Which asset to use when the job produced multiple outputs. Default 0.pollIfRunning· boolean · optionnel
When true, advance polling once if the job is still running. Default true.pollTimeoutMs· integer · optionnel
When pollIfRunning is true, wait up to this long for terminal state. Default 30000.
Exemple d'appel{"name": "attach_post_cover_from_job", "arguments": {"jobId": "texte", "postId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - attach_tags≈ 281 tokens
Attach one or more tags to a member/account. Useful for segmenting members after filtering.
Paramètres, retour & exemple (2)
ParamètrestagId· string · requis
Tag ID to attachaccountIds· array · requis
Member/account IDs to tag (max 100)
Exemple d'appel{"name": "attach_tags", "arguments": {"tagId": "texte", "accountIds": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - backfill_conversation_summaries≈ 643 tokens
Find conversations with no usable cached AI summary (missing or malformed; legacy valid caches are never touched) and generate them, at most limit per call (default 10, max 10). Newest activity first; only conversations you may read are considered. Default dryRun=true lists candidates with no model call, billing or writes. Set dryRun=false to generate; it is billed to company credits and needs company AI summaries enabled. Stops on the first generation failure, missing AI gateway configuration (rejected before any request, not billed), disabled flag, unknown usage or lost access. Cursor rules: use executeCursor from a preview to execute from its frozen window and starting position; eligibility is rechecked. nextCursor only continues the mode that produced it. Scans at most 50 visible rows per call, so hasMore may be true with no candidates in this page.
Paramètres, retour & exemple (5)
Paramètresdays· integer · optionnel
Rolling window in days by last message time, 1-90 (default 30)limit· integer · optionnel
Max generation attempts in this call, 1-10 (default 10). A remaining time budget can yield fewer.cursor· string · optionnel
Opaque cursor from an earlier call. Pass the same cursor to the same mode to continue.dryRun· boolean · optionnel
true (default) previews candidates with no model call, billing or writes. false generates summaries.channel· string · optionnel · whatsapp | sms | email | messenger | instagram | threads | web_form
Only conversations on this channel
Exemple d'appel{"name": "backfill_conversation_summaries", "arguments": {"days": 1, "limit": 1, "cursor": "texte", "dryRun": true, "channel": "whatsapp"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - cancel_booking≈ 366 tokens
Cancel a booking and create a durable refund receipt. Uses the merchant refund setting unless refundMethod is provided.
Paramètres, retour & exemple (4)
Paramètresreason· string · optionnel
Cancellation reasonbookingId· string · requis
The booking ID to cancelrefundMethod· string · optionnel · manual | account_credit
Refund cash manually or convert refundable cash to member creditidempotencyKey· string · requis
Unique key for this cancellation attempt; reuse it only when retrying the same request
Exemple d'appel{"name": "cancel_booking", "arguments": {"bookingId": "texte", "idempotencyKey": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - cancel_subscription≈ 268 tokens
Cancel a subscription. Destructive — turns off auto-renew and prevents further billing cycles. Existing paid periods stay valid until end.
Paramètres, retour & exemple (1)
ParamètressubscriptionId· string · requis
Subscription ID
Exemple d'appel{"name": "cancel_subscription", "arguments": {"subscriptionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - check_plan_operation≈ 370 tokens
Preflight whether an intended operation is allowed by token scopes, enabled modules, subscription state, and quota. Provide toolName, quotaCode, or moduleCode.
Paramètres, retour & exemple (4)
Paramètresdelta· integer · optionnel
Planned usage increment. Currently quota checks are single-resource preflights.toolName· string · optionnel
MCP tool name to preflight, e.g. create_accountquotaCode· string · optionnel
Quota code to check, e.g. contacts or mcp_calls_per_minutemoduleCode· string · optionnel
Module code to check, e.g. whatsapp or crm
Exemple d'appel{"name": "check_plan_operation", "arguments": {"delta": 1, "toolName": "texte", "quotaCode": "texte", "moduleCode": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - clone≈ 346 tokens
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.
Paramètres, retour & exemple (3)
Paramètresname· string · optionnel
Override the name of the cloned entity (defaults to "Original Name (Copy)")entityId· string · requis
ID of the entity to cloneentityType· string · requis · product | tier | campaign | post | service_package | promotion | gift_offer
Type of entity to clone
Exemple d'appel{"name": "clone", "arguments": {"entityId": "texte", "entityType": "product"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - commit_customer_import≈ 886 tokens
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.
Paramètres, retour & exemple (2)
Paramètresrows· array · requissessionId· string · requis
sessionId from preview_customer_import
Exemple d'appel{"name": "commit_customer_import", "arguments": {"rows": [], "sessionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - complete_booking≈ 251 tokens
Mark a booking as completed. Triggers commission calculation if configured.
Paramètres, retour & exemple (1)
ParamètresbookingId· string · requis
The booking ID to complete
Exemple d'appel{"name": "complete_booking", "arguments": {"bookingId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - confirm_booking≈ 238 tokens
Confirm a pending booking.
Paramètres, retour & exemple (1)
ParamètresbookingId· string · requis
The booking ID to confirm
Exemple d'appel{"name": "confirm_booking", "arguments": {"bookingId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - convert_lead≈ 458 tokens
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.
Paramètres, retour & exemple (7)
ParamètresdealName· string · optionnel
Optional deal nameaccountId· string · requis
Lead account IDdealStage· string · optionnel · discovery | qualified | proposal | negotiation | won | lost | lead | new
Optional initial deal stage ("lead" is an alias of "discovery")lifeStage· string · optionnel · active | vip
Lifecycle after convert (default active)createDeal· boolean · optionnel
Deprecated and ignored — a convert always links a dealdealAmount· number · optionnel
Optional deal amountdealClosingDate· string · optionnel
Optional deal close date
Exemple d'appel{"name": "convert_lead", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - copy_service_tier_pricing≈ 464 tokens
Copy the complete pricing and booking-policy configuration from one membership tier to another on the same booking service.
Paramètres, retour & exemple (3)
ParamètresserviceId· string · requis
Booking service IDsourceTierId· string · requis
Membership tier to copy fromtargetTierId· string · requis
Membership tier to replace
Exemple d'appel{"name": "copy_service_tier_pricing", "arguments": {"serviceId": "texte", "sourceTierId": "texte", "targetTierId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_account≈ 662 tokens
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.
Paramètres, retour & exemple (13)
Paramètresname· string · requis
Account/customer display nametype· string · optionnel · individual | business | household
Account type. Defaults to individual.email· string · optionnel
Email addressnotes· string · optionnel
Internal notesphone· string · optionnel
Phone numbersource· string · optionnel · walk_in | online | pos | whatsapp | referral | import | api | shopify
Acquisition source. Defaults to api.tierId· string · optionnel
Membership tier ID to enroll into. If omitted, the company default tier may apply.address· object · optionnel
Postal addresslastName· string · optionnel
Last name for individual accountsexpiresAt· string · optionnel
Optional ISO expiry for the membershipfirstName· string · optionnel
First name for individual accountslifeStage· string · optionnel · lead | active | churned | vip | prospect
CRM life stage. Defaults to active.enrollMembership· boolean · optionnel
Whether to create an active membership immediately
Exemple d'appel{"name": "create_account", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_booking≈ 403 tokens
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.
Paramètres, retour & exemple (8)
Paramètresnotes· string · optionnel
Booking notesendTime· string · requis
End time in HH:MM formatstaffId· string · optionnel
Staff member IDaccountId· string · requis
The member/account IDserviceId· string · requis
The service IDstartTime· string · requis
Start time in HH:MM formatresourceId· string · optionnel
Resource IDbookingDate· string · requis
Date in YYYY-MM-DD format
Exemple d'appel{"name": "create_booking", "arguments": {"endTime": "texte", "accountId": "texte", "serviceId": "texte", "startTime": "texte", "bookingDate": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_campaign≈ 739 tokens
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".
Paramètres, retour & exemple (9)
Paramètresname· string · requis
Campaign name (internal)status· string · optionnel · DRAFT | SCHEDULED
Default DRAFTchannel· string · requis · sms | email | whatsapp | push
email | sms | whatsapp | pushsegmentId· ? · optionnel
Required if recipientSource="segment"scheduledAt· ? · optionnel
ISO datetime for scheduled send (status must be SCHEDULED)recipientIds· array · optionnel
Required if recipientSource="individual", "list", or "csv"; values are account IDschannelConfig· object · optionnel
Channel-specific config: subject + htmlBody + optional plainTextBody for email; body for sms; approved templateId plus required bodyParameters, headerTextParameter, or headerMediaUrl and optional whatsappConnectionId for whatsapp. Legacy email html is normalized to htmlBody.recipientSource· string · optionnel · all | segment | individual | csv | list
Where to source recipients from. "list" is normalized to "individual".audienceExclusions· object · optionnel
Optional exclusions: accountIds contains specific customer account IDs; campaignIds contains previous campaign IDs whose accepted recipients must be omitted. A recipient matching any rule is excluded.
Exemple d'appel{"name": "create_campaign", "arguments": {"name": "texte", "channel": "sms"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_category≈ 316 tokens
Create a CMS post category (e.g. "Equipment", "Injection — Botox"). For sub-categories, use namespaced names — the table is flat.
Paramètres, retour & exemple (4)
Paramètresname· string · requis
Category nameslug· string · optionnel
Auto-generated from name if omitted.sortOrder· number · optionnel
Sort order (lower = earlier)description· string · optionnel
Description
Exemple d'appel{"name": "create_category", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_contact≈ 318 tokens
Create a contact on an existing CRM account.
Paramètres, retour & exemple (6)
Paramètresname· string · requis
Contact nameemail· string · optionnel
Emailphone· string · optionnel
PhonejobTitle· string · optionnel
Job titleaccountId· string · requis
Owning account IDisPrimary· boolean · optionnel
Mark as primary contact
Exemple d'appel{"name": "create_contact", "arguments": {"name": "texte", "accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_crm_task≈ 518 tokens
Create a CRM follow-up task for you or, where your assignment policy allows, another active member. Optionally link it to a CRM account or conversation you can see. dueAt must be an exact datetime with a timezone; resolve relative dates such as "tomorrow" with the user first.
Paramètres, retour & exemple (7)
ParamètresdueAt· string · optionnel
Exact ISO 8601 datetime with timezone offset or Z. Relative dates like "tomorrow" must be resolved by the user first.title· string · requis
Task titleownerId· ? · optionnel
Owner users.id. Defaults to you. Null leaves the task unassigned.priority· string · optionnel · low | medium | high | urgent
Priority (default medium)relatedId· string · optionnel
ID of the account or conversation named by relatedTypedescription· string · optionnel
DetailsrelatedType· string · optionnel · account | conversation | none
Link to a CRM account or conversation. Default none.
Exemple d'appel{"name": "create_crm_task", "arguments": {"title": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_custom_field≈ 457 tokens
Create a custom field definition for CRM entities. Use options for select or multiselect fields.
Paramètres, retour & exemple (7)
Paramètresoptions· array · optionnel
Allowed values for select/multiselect fieldsfieldName· string · requis
Stable machine name, e.g. preferred_branchfieldType· string · requis · text | number | date | select | multiselect | boolean | url | email
Field typesortOrder· number · optionnel
Display orderentityType· string · requis · account | contact | deal | booking | ticket | product | post
Entity type, e.g. account, contact, deal, bookingfieldLabel· string · requis
Human-readable label, e.g. Preferred branchisRequired· boolean · optionnel
Whether this field is required
Exemple d'appel{"name": "create_custom_field", "arguments": {"fieldName": "texte", "fieldType": "text", "entityType": "account", "fieldLabel": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_deal≈ 478 tokens
Create a CRM sales pipeline deal, optionally linked to a customer account and contact.
Paramètres, retour & exemple (10)
Paramètresname· string · requis
Deal namestage· ? · optionnel
Pipeline stageamount· ? · optionnel
Deal amountownerId· ? · optionnel
Owner user/team member IDdealType· ? · optionnel
Deal type/categoryaccountId· ? · optionnel
Linked CRM account IDcontactId· ? · optionnel
Linked contact IDclosingDate· ? · optionnel
Expected closing datedescription· ? · optionnel
Deal notes or descriptionprobability· ? · optionnel
Win probability, e.g. 25
Exemple d'appel{"name": "create_deal", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_inbox_reply_suggestion≈ 449 tokens
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.
Paramètres, retour & exemple (6)
Paramètresbody· string · requis
Draft reply text for the merchant to reviewagentId· string · requis
AI colleague ID creating the suggestionsubject· string · optionnel
Optional email subject suggestionmetadata· object · optionnel
Optional metadata such as rationale, confidence, or source refsconversationId· string · requis
Inbox conversation IDsourceMessageId· string · optionnel
Inbound message ID this draft responds to
Exemple d'appel{"name": "create_inbox_reply_suggestion", "arguments": {"body": "texte", "agentId": "texte", "conversationId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_invoice≈ 430 tokens
Create a new invoice for a customer. Optionally include line items inline. Returns the new invoiceId.
Paramètres, retour & exemple (5)
Paramètresnotes· string · optionnel
Free-form notes shown on the invoicedueDate· string · optionnel
Due date (ISO 8601 date)currency· string · optionnel
ISO currency code (defaults to company default)accountId· string · requis
Customer accountId (CRM account)lineItems· array · optionnel
Line items to bill — totals are computed server-side
Exemple d'appel{"name": "create_invoice", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_note≈ 310 tokens
Add a note to a member/account, booking, ticket, or invoice.
Paramètres, retour & exemple (4)
Paramètresbody· string · requis
Note contententityId· string · requis
The entity IDisPinned· boolean · optionnel
Pin this note to the topentityType· string · requis · account | booking | ticket | invoice
Type of entity
Exemple d'appel{"name": "create_note", "arguments": {"body": "texte", "entityId": "texte", "entityType": "account"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_offer_rule≈ 507 tokens
Create an upsell/cross-sell offer rule as draft. Specify trigger type, conditions, and suggested products with optional discounts.
Paramètres, retour & exemple (6)
Paramètresname· string · requis
Rule nametype· string · requis · upsell | cross_sell | bundle | post_purchase
Rule type: upsell, cross_sell, bundle, or post_purchaseproducts· array · optionnel
Products to suggest with optional discountsdescription· string · optionnel
Rule descriptiontriggerType· string · requis · product_view | cart_contains | cart_threshold | post_order | category_view
When the offer triggerstriggerConfig· object · optionnel
Trigger-specific configuration
Exemple d'appel{"name": "create_offer_rule", "arguments": {"name": "texte", "type": "upsell", "triggerType": "product_view"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_outlet≈ 494 tokens
Create a shop outlet/location. Optionally pass id to preserve a legacy UUID during migration.
Paramètres, retour & exemple (10)
Paramètresid· string · optionnel
Optional outlet UUID (for legacy migration; non-standard formats accepted)name· string · requis
Outlet namephone· ? · optionnel
Contact phoneaddress· ? · optionnel
Street addresslogoUrl· ? · optionnel
Logo URLisActive· boolean · optionnel
Whether outlet is active (default true)latitude· ? · optionnel
Latitudelongitude· ? · optionnel
LongitudesortOrder· integer · optionnel
Display sort order (default 0)acceptsOrders· boolean · optionnel
Whether outlet accepts online orders (default true)
Exemple d'appel{"name": "create_outlet", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_plan_upgrade_link≈ 410 tokens
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.
Paramètres, retour & exemple (5)
ParamètresplanId· string · optionnel
Target plan ID. Use list_plan_options first if unknown.confirm· boolean · optionnel
Required true to create a Stripe-hosted payment or billing link.planCode· string · optionnel
Target plan code, e.g. favcrm-lite. Either planId or planCode is required.returnUrl· string · optionnel
Where Stripe should return after checkout/portal. Defaults to merchant billing settings.billingCycle· string · optionnel · monthly | yearly
Exemple d'appel{"name": "create_plan_upgrade_link", "arguments": {"planId": "texte", "confirm": true, "planCode": "texte", "returnUrl": "texte", "billingCycle": "monthly"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_post≈ 3206 tokens
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.
Paramètres, retour & exemple (16)
Paramètresmeta· object · optionnel
Structured custom field values, keyed by field key (see list_post_type_fields). Validated against the post type field schema. Use this for all machine-readable data — never put JSON in excerpt.slug· string · optionnel
URL slug. Auto-generated from title if omitted; collisions get -2, -3 suffix.type· string · requis
Post type slug (e.g. blog_post, page, treatment). Must exist in post_types for this company.title· string · requis
Post titleblocks· array · optionnel
Ordered array of content blocks. Each block has { id, version, type, data } where type is one of: paragraph, heading, image, list, quote, code, divider, spacer, embed, html, youtube, file, faq, callout, gallery, cta, accordion, product, columns. Unknown types are rejected.status· string · optionnel · draft | scheduled | published | archived
Status (default draft)tagIds· array · optionnel
Tag IDs to attach to the postexcerpt· string · optionnel
Plain-text summary only — never JSON. Auto-derived from the first paragraph/heading block if omitted and the post type supports excerpts.parentId· ? · optionnel
Parent post ID for nested types (e.g. pages).seoTitle· string · optionnel
SEO title overridesortOrder· number · optionnel
Sort order (lower = earlier)visibility· string · optionnel · public | private | members_only
Visibility (default public)categoryIds· array · optionnel
Category IDs (post types with supportsCategories only)publishedAt· ? · optionnel
ISO timestamp; required when status=scheduled.featuredImage· string · optionnel
Cover image URLseoDescription· string · optionnel
SEO meta description
Exemple d'appel{"name": "create_post", "arguments": {"type": "texte", "title": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_post_type≈ 500 tokens
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.
Paramètres, retour & exemple (10)
Paramètresicon· ? · optionnel
Icon name or URLslug· string · requis
Lowercase identifier, e.g. "treatment". Auto-derived from label if omitted.label· string · requis
Singular UI label, e.g. "Treatment"sortOrder· number · optionnel
Sort order (lower = earlier)labelPlural· string · requis
Plural UI label, e.g. "Treatments"supportsBlocks· boolean · optionnel
Default truesupportsExcerpt· boolean · optionnel
Default truesupportsNesting· boolean · optionnel
Default falsesupportsCategories· boolean · optionnel
Default truesupportsFeaturedImage· boolean · optionnel
Default true
Exemple d'appel{"name": "create_post_type", "arguments": {"slug": "texte", "label": "texte", "labelPlural": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_post_type_field≈ 932 tokens
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.
Paramètres, retour & exemple (9)
Paramètreskey· string · optionnel
snake_case key used in meta. Auto-derived from label if omitted.label· string · requis
Human-readable field label, e.g. "Tagline"fields· array · optionnel
Required for fieldType="repeater". Defines the child fields stored in each row object.options· object · optionnel
For select/multiselect: { choices: [{ label, value }] }. For URL fields that should accept merchant uploads, use { uploadable: true } so the UI stores the uploaded file URL instead of asking the merchant to paste a raw URL.helpText· string · optionnel
Optional hint shown in the UIrequired· boolean · optionnel
Whether the field is required on post creation (default false)fieldType· string · requis · text | textarea | richtext | number | boolean | date | datetime | select
Field type: text | textarea | richtext | number | boolean | date | datetime | select | multiselect | url | email | image | file | gallery | attachments | repeatersortOrder· number · optionnel
Sort order (lower = earlier)postTypeId· string · requis
Post type ID (from list_post_types)
Exemple d'appel{"name": "create_post_type_field", "arguments": {"label": "texte", "fieldType": "text", "postTypeId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_product≈ 397 tokens
Create a new shop product as DRAFT. Merchant can review and activate from the portal.
Paramètres, retour & exemple (8)
Paramètressku· string · optionnel
SKU codename· string · requis
Product nameprice· string · requis
Price as decimal string (e.g. "29.99")categoryIds· array · optionnel
Category IDs (first is primary)description· string · optionnel
Product descriptionmemberPrice· string · optionnel
Members-only priceproductType· string · optionnel · one_time | recurring
Product type (default one_time)discountPrice· string · optionnel
Discounted price
Exemple d'appel{"name": "create_product", "arguments": {"name": "texte", "price": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_product_category≈ 334 tokens
Create a product category. Use parentId to create subcategories under an existing category.
Paramètres, retour & exemple (5)
Paramètresname· string · requis
Category nameparentId· number · optionnel
Parent category ID for subcategoriessortOrder· number · optionnel
Display sort orderdescription· string · optionnel
Category descriptiononlineEnabled· boolean · optionnel
Show in online store (default true)
Exemple d'appel{"name": "create_product_category", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_promotion≈ 687 tokens
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.
Paramètres, retour & exemple (17)
Paramètrescode· string · requis
Coupon code customers enter at checkout (auto-uppercased)name· string · requis
Promotion name (internal)type· string · optionnel · percentage | fixed_amount
Default percentagevalue· string · requis
Discount value as decimal stringendsAt· ? · optionnel
ISO datetime — when the promo expiresstatus· string · optionnel · active | inactive | expired
Default activestartsAt· ? · optionnel
ISO datetime — when the promo becomes validposEnabled· boolean · optionnel
Allow at POSdescription· string · optionnel
DescriptioneventEnabled· boolean · optionnel
Allow on event registrationsminimumAmount· ? · optionnel
Minimum order amount required, decimal stringonlineEnabled· boolean · optionnel
Allow on online shop ordersbookingEnabled· boolean · optionnel
Allow on bookingsmaximumDiscount· ? · optionnel
Cap on percentage discounts, decimal stringminimumQuantity· ? · optionnel
Minimum item count requiredusageLimitTotal· ? · optionnel
Max total uses across all customersusageLimitPerCustomer· ? · optionnel
Max uses per single customer
Exemple d'appel{"name": "create_promotion", "arguments": {"code": "texte", "name": "texte", "value": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_resource≈ 348 tokens
Create a bookable resource (room, equipment, vehicle). Used by services that have requiresResource=true.
Paramètres, retour & exemple (5)
Paramètresname· string · requis
Resource name (e.g. "Treatment Room A")type· string · requis
Free-form type label, e.g. "room", "equipment"status· string · optionnel · active | inactive
Default activecapacity· number · optionnel
How many concurrent bookings (default 1)description· string · optionnel
Description
Exemple d'appel{"name": "create_resource", "arguments": {"name": "texte", "type": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_segment≈ 677 tokens
Create a new customer segment. Use STATIC for manual member lists, DYNAMIC for criteria-based auto-filtering.
Paramètres, retour & exemple (4)
Paramètresname· string · requis
Segment namecriteria· object · optionnel
Dynamic segment criteriadescription· string · optionnel
Segment descriptionsegmentType· string · optionnel · STATIC | DYNAMIC
Segment type (default DYNAMIC)
Exemple d'appel{"name": "create_segment", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_service≈ 774 tokens
Create a bookable service. Sets duration, price, capacity, and policies. Use list_service_categories first if you want to attach to an existing category.
Paramètres, retour & exemple (20)
Paramètresname· string · requis
Service nametype· string · optionnel · one_on_one | group | class
Default one_on_oneprice· string · optionnel
Decimal string, e.g. "80.00". Defaults to "0".status· string · optionnel · active | inactive | archived
Default activecapacity· number · optionnel
How many participants per slot (default 1)currency· string · optionnel
ISO currency code, default HKDsortOrder· number · optionnel
Sort order (lower = earlier)categoryId· string · optionnel
Existing service category IDvisibility· string · optionnel · public | members_only | hidden
Visibility: public | members_only | hiddendescription· string · optionnel
DescriptionrequireLogin· boolean · optionnel
Default true — guests cannot bookrequiresStaff· boolean · optionnel
Whether the service requires staff assignmentallowedTierIds· array · optionnel
Required when visibility=members_onlycommissionType· ? · optionnel
Commission type: "fixed" or "percentage"commissionValue· ? · optionnel
Commission amount as decimal stringcooldownMinutes· number · optionnel
Minimum gap before bookings can be cancelled (default 0)durationMinutes· number · requis
Duration of one booking in minutesrequiresResource· boolean · optionnel
Whether the service requires a resource (room/equipment)commissionCurrency· ? · optionnel
Commission currency (ISO code)requiresConfirmation· boolean · optionnel
If true, bookings start as pending and need confirm_booking
Exemple d'appel{"name": "create_service", "arguments": {"name": "texte", "durationMinutes": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_service_category≈ 288 tokens
Create a service category (e.g. "Treatments", "Classes") to group bookable services.
Paramètres, retour & exemple (3)
Paramètresname· string · requis
Category namesortOrder· number · optionnel
Sort order (lower = earlier)description· string · optionnel
Description
Exemple d'appel{"name": "create_service_category", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_service_package≈ 506 tokens
Create a service package/prepaid session bundle. Use applicableType=SELECTED with applicableItems to limit the package to specific booking services or events.
Paramètres, retour & exemple (8)
Paramètresname· string · requis
Package nameprice· number · requis
Package pricestatus· string · optionnel · ACTIVE | INACTIVE
Default ACTIVEvalidDays· integer · requis
Validity window after purchase, in daysdescription· string · optionnel
DescriptionsessionCount· integer · requis
Number of included sessionsapplicableType· string · optionnel · ALL | ALL_BOOKINGS | ALL_EVENTS | SELECTED
Default ALLapplicableItems· array · optionnel
Items used when applicableType=SELECTED
Exemple d'appel{"name": "create_service_package", "arguments": {"name": "texte", "price": 1, "validDays": 1, "sessionCount": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_service_schedule≈ 513 tokens
Create a bookable schedule window for a service, including recurring weekly/daily availability.
Paramètres, retour & exemple (12)
Paramètresdate· string · requis
Start date or one-off date (YYYY-MM-DD)notes· string · optionnel
Free-form notesendTime· string · requis
HH:MM (24h)staffId· string · optionnel
Optional companyMembers.id to bind this schedule to staffbyWeekday· array · optionnel
Weekdays for weekly recurrence: 0=Mon, 1=Tue, ... 6=SunserviceId· string · requis
Service IDstartTime· string · requis
HH:MM (24h)recurrence· string · optionnel · none | daily | weekly | monthly
Default noneresourceId· string · optionnel
Optional resource ID to bind this schedule to a room/resourcemaxCapacity· number · optionnel
Max bookings per generated slotrecurrenceEndDate· string · optionnel
YYYY-MM-DDrecurrenceInterval· number · optionnel
Default 1
Exemple d'appel{"name": "create_service_schedule", "arguments": {"date": "texte", "endTime": "texte", "serviceId": "texte", "startTime": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_subscription≈ 462 tokens
Create a manual, non-renewing subscription record for a member. Use a subscription action link for provider-backed recurring billing.
Paramètres, retour & exemple (8)
Paramètresamount· number · optionnel
Override amount per cycle (otherwise derived from tier)tierId· string · optionnel
Membership tier ID — if set, amount/currency default from the tiercurrency· string · optionnel
ISO currency code (otherwise derived from tier or company default)accountId· string · requis
Customer accountIdautoRenew· boolean · optionnel
Manual records cannot auto-renewbillingCycle· string · optionnel · monthly | quarterly | yearly | one_off
Billing cycle (default monthly)currentPeriodEnd· string · optionnel
Period end (ISO 8601). Defaults to start + cycle.currentPeriodStart· string · optionnel
Period start (ISO 8601). Defaults to now.
Exemple d'appel{"name": "create_subscription", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_survey≈ 526 tokens
Create a survey with custom question blocks. Publish it later or set status to published for immediate portal access.
Paramètres, retour & exemple (9)
Paramètresslug· string · optionnel
Optional URL slug; generated from title when omittedtitle· string · requis
Survey titleopenAt· string · optionnel
Optional ISO datetime when the survey opensstatus· string · optionnel · draft | published | closed | archived
Initial statuscloseAt· string · optionnel
Optional ISO datetime when the survey closessettings· object · optionnel
Survey settings such as allowMultipleResponses, collectEmail, collectIpAddress, requireAuthentication, showProgress, successMessagevisibility· string · optionnel · public | members_only | token_only | private
Who can access the surveydescription· string · optionnel
Optional survey descriptionquestionBlocks· array · requis
Ordered survey question blocks
Exemple d'appel{"name": "create_survey", "arguments": {"title": "texte", "questionBlocks": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_survey_invitation≈ 475 tokens
Create a token-auth survey invitation for a specific member/account or contact.
Paramètres, retour & exemple (9)
Paramètreschannel· string · optionnel
Intended channel, e.g. email, sms, whatsapp, linkmetadata· object · optionnel
Optional invitation metadatasurveyId· string · requis
Survey IDaccountId· string · optionnel
CRM account ID to invitecontactId· string · optionnel
Contact ID to inviteexpiresAt· string · optionnel
Optional invitation expiry ISO datetimerecipientName· string · optionnel
Recipient display name for link trackingrecipientEmail· string · optionnel
Recipient email for link trackingrecipientPhone· string · optionnel
Recipient phone for link tracking
Exemple d'appel{"name": "create_survey_invitation", "arguments": {"surveyId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_tag≈ 262 tokens
Create a CRM tag for customer segmentation and organization.
Paramètres, retour & exemple (2)
Paramètresname· string · requis
Tag namecolor· string · optionnel
Optional display color, e.g. #2563eb
Exemple d'appel{"name": "create_tag", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_task≈ 366 tokens
Create a task. Optionally link to a CRM account or assign to a team member.
Paramètres, retour & exemple (7)
Paramètrestitle· string · requis
Task titlestatus· string · optionnel · todo | in_progress | blocked | done
Status filterdueDate· string · optionnel
ISO date (YYYY-MM-DD)priority· string · optionnel · low | medium | high | urgent
PriorityaccountId· string · optionnel
Linked CRM accountassigneeId· string · optionnel
company_members.iddescription· string · optionnel
Description
Exemple d'appel{"name": "create_task", "arguments": {"title": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_team_member_invite≈ 538 tokens
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.
Paramètres, retour & exemple (6)
Paramètresname· string · optionnel
Optional display name for a new userrole· string · optionnel · manager | staff
Team member role to grant on acceptanceemail· string · requis
Invitee email addressmodules· array · optionnel
Optional legacy module list to attach to the company memberpermissions· array · optionnel
Optional structured module permissions to attach to the company memberexpiresInHours· integer · optionnel
Invite lifetime in hours. Defaults to 72, max 336.
Exemple d'appel{"name": "create_team_member_invite", "arguments": {"email": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_template≈ 517 tokens
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.
Paramètres, retour & exemple (7)
Paramètresname· string · requis
Friendly template name (a Meta-safe id is derived from it).footer· string · optionnel
Optional small footer text.message· string · requis
Body text. Use {{1}}, {{2}} for personalised values.category· string · requis · MARKETING | UTILITY | AUTHENTICATION
UTILITY = transactional (order/shipping), MARKETING = promos, AUTHENTICATION = codes.language· string · optionnel
Language code, default en_US.headerText· string · optionnel
Optional short bold header above the body.variableSamples· object · optionnel
Example values per variable number, e.g. {"1":"Sara"} — Meta reviews with these.
Exemple d'appel{"name": "create_template", "arguments": {"name": "texte", "message": "texte", "category": "MARKETING"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_ticket≈ 448 tokens
Create a support ticket for a member issue.
Paramètres, retour & exemple (9)
Paramètressource· string · optionnel · portal | email | phone | walk_in | api | mobile_app
Where the ticket originatedsubject· string · requis
Ticket subject/titlecategory· string · optionnel · bug | feature_request | account | billing | general | other
Ticket categorypriority· string · optionnel · critical | high | medium | low
Ticket priorityaccountId· string · optionnel
Member/account ID this ticket is aboutcontactName· string · optionnel
Contact name if no account IDdescription· string · optionnel
Detailed description of the issuecontactEmail· string · optionnel
Contact email if no account IDcontactPhone· string · optionnel
Contact phone if no account ID
Exemple d'appel{"name": "create_ticket", "arguments": {"subject": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_variation≈ 427 tokens
Add a variation (size, color, etc.) to an existing product.
Paramètres, retour & exemple (9)
Paramètressku· string · optionnel
Variation SKUname· string · optionnel
Variation nameprice· string · requis
Price as decimal string (e.g. "29.99")productId· number · requis
The product IDmemberPrice· string · optionnel
Members-only pricestockStatus· string · optionnel · in_stock | out_of_stock | low_stock
Stock statusdiscountPrice· string · optionnel
Discounted pricestockQuantity· number · optionnel
Stock quantityselectedOptions· object · optionnel
Option selections e.g. {"Size": "Large"}
Exemple d'appel{"name": "create_variation", "arguments": {"price": "texte", "productId": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - create_whatsapp_connect_link≈ 351 tokens
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.
Paramètres, retour & exemple (2)
ParamètresttlMinutes· integer · optionnel
Connect link lifetime in minutes. Defaults to 30.onboardingMode· string · optionnel · cloud_api | coexistence
Use cloud_api for a new WhatsApp Cloud API connection, or coexistence when connecting a WhatsApp Business App number.
Exemple d'appel{"name": "create_whatsapp_connect_link", "arguments": {"ttlMinutes": 1, "onboardingMode": "cloud_api"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_account≈ 263 tokens
Soft-delete a CRM account/customer. This releases the primary phone for future reuse while keeping account history for audit.
Paramètres, retour & exemple (1)
ParamètresaccountId· string · requis
The account ID to soft-delete
Exemple d'appel{"name": "delete_account", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_campaign≈ 251 tokens
Delete a campaign. Only allowed in DRAFT status; sent campaigns are kept for audit history.
Paramètres, retour & exemple (1)
ParamètrescampaignId· string · requis
Campaign ID
Exemple d'appel{"name": "delete_campaign", "arguments": {"campaignId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_category≈ 252 tokens
Delete a CMS post category. Posts in the category are not deleted; they are simply unlinked.
Paramètres, retour & exemple (1)
ParamètrescategoryId· string · requis
Category ID
Exemple d'appel{"name": "delete_category", "arguments": {"categoryId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_contact≈ 260 tokens
Delete a secondary contact. Primary contacts are protected; set another primary contact or delete the account instead.
Paramètres, retour & exemple (1)
ParamètrescontactId· string · requis
The contact ID to delete
Exemple d'appel{"name": "delete_contact", "arguments": {"contactId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_custom_field≈ 249 tokens
Delete a custom field definition and its stored values.
Paramètres, retour & exemple (1)
ParamètresdefinitionId· string · requis
Custom field definition ID
Exemple d'appel{"name": "delete_custom_field", "arguments": {"definitionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_deal≈ 239 tokens
Soft-delete a CRM deal from the sales pipeline.
Paramètres, retour & exemple (1)
ParamètresdealId· string · requis
The deal ID to delete
Exemple d'appel{"name": "delete_deal", "arguments": {"dealId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_invoice≈ 256 tokens
Delete a DRAFT invoice. Only invoices that have never been sent can be deleted; otherwise use void_invoice.
Paramètres, retour & exemple (1)
ParamètresinvoiceId· string · requis
Invoice ID to delete
Exemple d'appel{"name": "delete_invoice", "arguments": {"invoiceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_knowledge_document≈ 270 tokens
Soft-delete a knowledge document. The agent loses access immediately, but the document can be restored with restore_knowledge_document.
Paramètres, retour & exemple (1)
ParamètresdocumentId· string · requis
Knowledge document ID
Exemple d'appel{"name": "delete_knowledge_document", "arguments": {"documentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_post≈ 244 tokens
Delete a CMS post by ID. Soft-deleted posts can be restored with restore_post.
Paramètres, retour & exemple (1)
ParamètrespostId· string · requis
The post ID
Exemple d'appel{"name": "delete_post", "arguments": {"postId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_post_type≈ 261 tokens
Delete a custom post type. Built-in types cannot be deleted. Fails if any posts of this type still exist — delete those first.
Paramètres, retour & exemple (1)
ParamètrespostTypeId· string · requis
Post type ID
Exemple d'appel{"name": "delete_post_type", "arguments": {"postTypeId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_post_type_field≈ 320 tokens
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).
Paramètres, retour & exemple (3)
Paramètresforce· boolean · optionnel
Delete even if posts have data in this field. Existing meta values become orphaned.fieldId· string · requis
Field IDpostTypeId· string · requis
Post type ID
Exemple d'appel{"name": "delete_post_type_field", "arguments": {"fieldId": "texte", "postTypeId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_promotion≈ 243 tokens
Delete a promotion. Past usage records are preserved.
Paramètres, retour & exemple (1)
ParamètrespromotionId· string · requis
Promotion ID
Exemple d'appel{"name": "delete_promotion", "arguments": {"promotionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_segment≈ 237 tokens
Delete a customer segment.
Paramètres, retour & exemple (1)
ParamètressegmentId· string · requis
The segment ID to delete
Exemple d'appel{"name": "delete_segment", "arguments": {"segmentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_service_package≈ 244 tokens
Delete a service package by ID.
Paramètres, retour & exemple (1)
ParamètrespackageId· string · requis
Service package ID to delete
Exemple d'appel{"name": "delete_service_package", "arguments": {"packageId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_tag≈ 240 tokens
Delete a CRM tag and remove it from all tagged entities.
Paramètres, retour & exemple (1)
ParamètrestagId· string · requis
The tag ID to delete
Exemple d'appel{"name": "delete_tag", "arguments": {"tagId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - delete_task≈ 233 tokens
Soft-delete a CRM task.
Paramètres, retour & exemple (1)
ParamètrestaskId· string · requis
The task ID to delete
Exemple d'appel{"name": "delete_task", "arguments": {"taskId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - detach_tags≈ 272 tokens
Detach one tag from one or more member/account records.
Paramètres, retour & exemple (2)
ParamètrestagId· string · requis
Tag ID to detachaccountIds· array · requis
Member/account IDs to untag (max 100)
Exemple d'appel{"name": "detach_tags", "arguments": {"tagId": "texte", "accountIds": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - earn_loyalty_points≈ 368 tokens
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.
Paramètres, retour & exemple (4)
Paramètresfield· string · requis · points | stamps
Which loyalty unit to creditamount· integer · requis
Positive integer amount to creditreason· string · optionnel
Audit-trail reason (e.g. "Booking completed", "Manual adjustment")accountId· string · requis
The member/account ID
Exemple d'appel{"name": "earn_loyalty_points", "arguments": {"field": "points", "amount": 1, "accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - enrol_membership≈ 335 tokens
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.
Paramètres, retour & exemple (3)
ParamètrestierId· string · optionnel
The membership tier ID. Omit to enrol on the default no-tier membership.accountId· string · requis
The member/account ID to enrolexpiresAt· string · optionnel
Optional ISO date to override the tier-computed expiry.
Exemple d'appel{"name": "enrol_membership", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - execute_tool≈ 329 tokens
Execute an available FavCRM tool by name after discovering it with search_tools. Target tool availability, input schema, module gates, and audit logging are still enforced.
Paramètres, retour & exemple (2)
ParamètrestoolName· string · requis
Exact target tool name returned by search_toolsarguments· object · optionnel
Arguments object for the target tool. Must match the target input schema.
Exemple d'appel{"name": "execute_tool", "arguments": {"toolName": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - find_or_create_workroom_thread≈ 352 tokens
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.
Paramètres, retour & exemple (3)
Paramètrestitle· string · optionnel
Optional title if a new thread is createduserId· string · optionnel
Merchant user ID to notify. Defaults to the current MCP user when omitted.agentId· string · requis
AI colleague ID for the Workroom DM
Exemple d'appel{"name": "find_or_create_workroom_thread", "arguments": {"agentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - generate_image≈ 500 tokens
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.
Paramètres, retour & exemple (7)
Paramètresseed· integer · optionnel
Random seed for reproducible outputprompt· string · requis
Generation promptmodelCode· string · requis
Image model code from list_image_modelsaspectRatio· string · optionnel
Output aspect ratio (e.g. 16:9, 1:1)pollTimeoutMs· integer · optionnel
Default 60000.negativePrompt· string · optionnel
Things to exclude from generationpollIntervalMs· integer · optionnel
Default 3000.
Exemple d'appel{"name": "generate_image", "arguments": {"prompt": "texte", "modelCode": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - generate_post_cover≈ 531 tokens
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.
Paramètres, retour & exemple (8)
Paramètresseed· integer · optionnel
Random seed for reproducible outputpostId· string · requis
The post IDprompt· string · requis
Image generation promptmodelCode· string · requis
Image model code from list_image_models (e.g. nano-banana-2)aspectRatio· string · optionnel
Aspect ratio passed to the model, e.g. "16:9", "1:1"pollTimeoutMs· integer · optionnel
Default 60000.negativePrompt· string · optionnel
Things to exclude from generationpollIntervalMs· integer · optionnel
Default 3000.
Exemple d'appel{"name": "generate_post_cover", "arguments": {"postId": "texte", "prompt": "texte", "modelCode": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_attachment_text≈ 322 tokens
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.
Paramètres, retour & exemple (1)
ParamètresattachmentId· string · requis
The attachment ID from the message attachments list
Exemple d'appel{"name": "get_attachment_text", "arguments": {"attachmentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_audit_log≈ 249 tokens
Fetch a single audit log entry by ID, including before/after snapshots when available.
Paramètres, retour & exemple (1)
ParamètresauditLogId· string · requis
Audit log ID
Exemple d'appel{"name": "get_audit_log", "arguments": {"auditLogId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_available_slots≈ 318 tokens
Find available booking slots for a service on a specific date.
Paramètres, retour & exemple (4)
Paramètresdate· string · requis
ISO date to check (YYYY-MM-DD)staffId· string · optionnel
Optional: filter by specific staff memberserviceId· string · requis
The service to check availability forresourceId· string · optionnel
Optional: filter by specific resource
Exemple d'appel{"name": "get_available_slots", "arguments": {"date": "texte", "serviceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_booking_detail≈ 250 tokens
Get full booking details including line items, status history, and participants.
Paramètres, retour & exemple (1)
ParamètresbookingId· string · requis
The booking ID
Exemple d'appel{"name": "get_booking_detail", "arguments": {"bookingId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_booking_settings≈ 240 tokens
Get global booking settings for the customer booking flow, cancellation rules, visibility options, and confirmation requirements.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_booking_settings", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_booking_stats≈ 225 tokens
Get booking counts: today, this week, this month, and breakdown by status.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_booking_stats", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_campaign≈ 256 tokens
Get a campaign by ID, including its recipient source, audience exclusions, channel configuration, and delivery stats.
Paramètres, retour & exemple (1)
ParamètrescampaignId· string · requis
Campaign ID
Exemple d'appel{"name": "get_campaign", "arguments": {"campaignId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_contact≈ 234 tokens
Fetch a single contact by ID.
Paramètres, retour & exemple (1)
ParamètrescontactId· string · requis
The contact ID
Exemple d'appel{"name": "get_contact", "arguments": {"contactId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_conversation_messages≈ 322 tokens
Get messages from a specific conversation thread. Shows the chat history between the merchant and a contact.
Paramètres, retour & exemple (4)
Paramètrespage· number · optionnel
Page number, newest first (default 1)limit· number · optionnel
Page size (default 20, max 50)search· string · optionnel
Search within messagesconversationId· string · requis
The conversation ID
Exemple d'appel{"name": "get_conversation_messages", "arguments": {"conversationId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_conversation_summary≈ 301 tokens
Read the cached AI summary of a conversation with freshness information. Read-only: never calls the model, never bills, never writes. Returns summary null when no cache exists. Use refresh_conversation_summary to regenerate.
Paramètres, retour & exemple (1)
ParamètresconversationId· string · requis
The conversation ID
Exemple d'appel{"name": "get_conversation_summary", "arguments": {"conversationId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_crm_task≈ 266 tokens
Get one CRM follow-up task you may see, with its UTC due instant and the company timezone. Unseen and missing tasks return not found.
Paramètres, retour & exemple (1)
ParamètrestaskId· string · requis
CRM task ID
Exemple d'appel{"name": "get_crm_task", "arguments": {"taskId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_custom_field≈ 242 tokens
Get a custom field definition by ID.
Paramètres, retour & exemple (1)
ParamètresdefinitionId· string · requis
Custom field definition ID
Exemple d'appel{"name": "get_custom_field", "arguments": {"definitionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_custom_field_values≈ 292 tokens
Get custom field values for a CRM entity such as an account, contact, deal, or booking.
Paramètres, retour & exemple (2)
ParamètresentityId· string · requis
Entity IDentityType· string · requis · account | contact | deal | booking | ticket | product | post
Entity type
Exemple d'appel{"name": "get_custom_field_values", "arguments": {"entityId": "texte", "entityType": "account"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_customer_brief≈ 353 tokens
Read-only customer brief for one account: details, tags, linked conversations with cached summaries, and open CRM tasks. Only records you may read are included. A section you cannot access is returned as null and listed in availableSections. Does not call the AI model.
Paramètres, retour & exemple (3)
ParamètresaccountId· string · requis
CRM account IDtaskLimit· number · optionnel
Max open tasks, 1-20 (default 10)conversationLimit· number · optionnel
Max linked conversations, 1-20 (default 10)
Exemple d'appel{"name": "get_customer_brief", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_dashboard_stats≈ 248 tokens
Get high-level business KPIs: member count, new members this week, active subscriptions, total points issued, active promotions, rewards redeemed, messages sent.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_dashboard_stats", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_deal≈ 233 tokens
Get detailed CRM deal information by ID.
Paramètres, retour & exemple (1)
ParamètresdealId· string · requis
The deal ID
Exemple d'appel{"name": "get_deal", "arguments": {"dealId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_event_campaign_exclusions≈ 296 tokens
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.
Paramètres, retour & exemple (1)
ParamètreseventId· string · requis
Event ID
Exemple d'appel{"name": "get_event_campaign_exclusions", "arguments": {"eventId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_invoice≈ 245 tokens
Fetch a single invoice with line items, payment history, and customer detail.
Paramètres, retour & exemple (1)
ParamètresinvoiceId· string · requis
Invoice ID
Exemple d'appel{"name": "get_invoice", "arguments": {"invoiceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_invoice_stats≈ 231 tokens
Outstanding totals, overdue counts, and revenue this period. Used by the weekly-snapshot playbook.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_invoice_stats", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_knowledge_document≈ 281 tokens
Fetch a single knowledge document with metadata + extraction/review status. Reviewed content is served via GET /v6/merchant/ai/knowledge/{id}/content; raw/extracted variants are for audit.
Paramètres, retour & exemple (1)
ParamètresdocumentId· string · requis
Knowledge document ID
Exemple d'appel{"name": "get_knowledge_document", "arguments": {"documentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_loyalty_balance≈ 271 tokens
Get a member's current loyalty balance — points, stamps, credits, lifetime totals, and active membership tier. Returns null if the member is not enrolled.
Paramètres, retour & exemple (1)
ParamètresaccountId· string · requis
The member/account ID
Exemple d'appel{"name": "get_loyalty_balance", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_member_profile≈ 244 tokens
Get detailed profile for a specific member/account by ID.
Paramètres, retour & exemple (1)
ParamètresaccountId· string · requis
The account ID
Exemple d'appel{"name": "get_member_profile", "arguments": {"accountId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_membership_tier≈ 237 tokens
Get a specific membership tier by ID.
Paramètres, retour & exemple (1)
ParamètrestierId· string · requis
The tier ID
Exemple d'appel{"name": "get_membership_tier", "arguments": {"tierId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_offer_rule≈ 244 tokens
Get offer rule detail including associated products and discounts.
Paramètres, retour & exemple (1)
ParamètresruleId· string · requis
The offer rule ID
Exemple d'appel{"name": "get_offer_rule", "arguments": {"ruleId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_order≈ 235 tokens
Get full order detail including line items.
Paramètres, retour & exemple (1)
ParamètresorderId· string · requis
The order UUID
Exemple d'appel{"name": "get_order", "arguments": {"orderId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_plan_status≈ 245 tokens
Show the current organisation plan, subscription/payment state, enabled modules, and quota usage. Use before deciding whether an agentic operation is allowed.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_plan_status", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_post≈ 240 tokens
Get detailed CMS post including content blocks, categories, and tags.
Paramètres, retour & exemple (1)
ParamètrespostId· string · requis
The post ID
Exemple d'appel{"name": "get_post", "arguments": {"postId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_product≈ 243 tokens
Get full product detail including images, options, and variations.
Paramètres, retour & exemple (1)
ParamètresproductId· number · requis
The product ID
Exemple d'appel{"name": "get_product", "arguments": {"productId": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_promotion≈ 241 tokens
Get details of a specific promotion/coupon code.
Paramètres, retour & exemple (1)
ParamètrespromotionId· string · requis
The promotion ID
Exemple d'appel{"name": "get_promotion", "arguments": {"promotionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_segment≈ 246 tokens
Get customer segment details including type, criteria, and live member count.
Paramètres, retour & exemple (1)
ParamètressegmentId· string · requis
The segment ID
Exemple d'appel{"name": "get_segment", "arguments": {"segmentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_segment_members≈ 261 tokens
Get the members that belong to a specific segment.
Paramètres, retour & exemple (2)
Paramètreslimit· number · optionnel
Max results (default 20)segmentId· string · requis
The segment ID
Exemple d'appel{"name": "get_segment_members", "arguments": {"segmentId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_service_detail≈ 250 tokens
Get full service details including addons, staff, resources, and tier pricing.
Paramètres, retour & exemple (1)
ParamètresserviceId· string · requis
The service ID
Exemple d'appel{"name": "get_service_detail", "arguments": {"serviceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_service_package≈ 254 tokens
Get service package detail including applicability and selected booking service/event items.
Paramètres, retour & exemple (1)
ParamètrespackageId· string · requis
Service package ID
Exemple d'appel{"name": "get_service_package", "arguments": {"packageId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_service_tier_pricing≈ 302 tokens
Read every membership-tier pricing configuration for one booking service.
Paramètres, retour & exemple (1)
ParamètresserviceId· string · requis
Booking service ID
Exemple d'appel{"name": "get_service_tier_pricing", "arguments": {"serviceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_subscription≈ 252 tokens
Fetch a single subscription with customer, tier, billing cycle, and renewal info.
Paramètres, retour & exemple (1)
ParamètressubscriptionId· string · requis
Subscription ID
Exemple d'appel{"name": "get_subscription", "arguments": {"subscriptionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_survey≈ 248 tokens
Get survey detail, including blocks, publishing status, visibility, settings, and response count.
Paramètres, retour & exemple (1)
ParamètressurveyId· string · requis
Survey ID
Exemple d'appel{"name": "get_survey", "arguments": {"surveyId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_survey_responses≈ 255 tokens
List responses for a survey.
Paramètres, retour & exemple (2)
Paramètreslimit· number · optionnel
Max responses (default 50)surveyId· string · requis
Survey ID
Exemple d'appel{"name": "get_survey_responses", "arguments": {"surveyId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_survey_stats≈ 244 tokens
Get response and invitation metrics for a survey overview dashboard.
Paramètres, retour & exemple (1)
ParamètressurveyId· string · requis
Survey ID
Exemple d'appel{"name": "get_survey_stats", "arguments": {"surveyId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_task≈ 232 tokens
Get detailed task information by ID.
Paramètres, retour & exemple (1)
ParamètrestaskId· string · requis
The task ID
Exemple d'appel{"name": "get_task", "arguments": {"taskId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_ticket_stats≈ 215 tokens
Get ticket counts grouped by status.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_ticket_stats", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - get_whatsapp_connection_status≈ 248 tokens
Check whether WhatsApp Business is connected for this company, including WABA/phone metadata and the latest agentic connect session state.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "get_whatsapp_connection_status", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - issue_rewards≈ 314 tokens
Issue a gift/reward to multiple members. Requires a gift offer ID and member IDs.
Paramètres, retour & exemple (3)
ParamètresexpiresAt· string · optionnel
Optional ISO date when the reward expiresmemberIds· array · requis
Member/account IDs to receive the reward (max 50)giftOfferId· string · requis
The gift offer/reward scheme ID to issue
Exemple d'appel{"name": "issue_rewards", "arguments": {"memberIds": [], "giftOfferId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}} - link_resource_to_service≈ 262 tokens
Link a room/resource to a booking service.
Paramètres, retour & exemple (2)
ParamètresserviceId· string · requis
Service IDresourceId· string · requis
Resource ID
Exemple d'appel{"name": "link_resource_to_service", "arguments": {"serviceId": "texte", "resourceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}], "structuredContent": {"data": "texte", "summary": "texte", "renderType": "table"}}
+ 117 autres outils (affichage limité à 120).
C'est votre serveur ?
Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».