MCP tools
Generated from the server’s tool list. Each tool states the scope it needs.
list_knowledge_bases
List the knowledge bases this key can use, with their languages and content counts.
Requires kb:read · reads
get_knowledge_base
Get one knowledge base: slug, default language, and languages (enabled or not).
Requires kb:read · reads
| Argument | Type | Description |
|---|---|---|
kbId (required) | string |
list_categories
The category tree of a knowledge base in one language, hidden categories included.
Requires categories:read · reads
| Argument | Type | Description |
|---|---|---|
kbId (required) | string | |
language (required) | string |
get_category
Get one category with its children and translations.
Requires categories:read · reads
| Argument | Type | Description |
|---|---|---|
id (required) | string |
create_category
Create a category in a knowledge base. Set parentId to nest it under another category of the same language.
Requires categories:write · writes
| Argument | Type | Description |
|---|---|---|
language (required) | string | |
parentId | string | |
slug (required) | string | |
name (required) | string | |
description | string | |
icon | string | |
tags | string[] | |
position | integer | |
kbId (required) | string |
update_category
Change a category. Only the fields given change; pass null to clear an optional field.
Requires categories:write · writes
| Argument | Type | Description |
|---|---|---|
parentId | string | |
slug | string | |
name | string | |
description | string | |
icon | string | |
tags | string[] | |
position | integer | |
id (required) | string |
delete_category
Delete a category. Its children move up to its parent and its articles become uncategorised.
Requires categories:write · deletes
| Argument | Type | Description |
|---|---|---|
id (required) | string |
create_category_translation
Create the translation of an existing category in another language of the same knowledge base.
Requires categories:write · writes
| Argument | Type | Description |
|---|---|---|
language (required) | string | |
parentId | string | |
slug (required) | string | |
name (required) | string | |
description | string | |
icon | string | |
tags | string[] | |
position | integer | |
sourceCategoryId (required) | string |
list_articles
List articles of a knowledge base in one language, all statuses, newest first. Bodies are omitted; use get_article.
Requires articles:read · reads
| Argument | Type | Description |
|---|---|---|
kbId (required) | string | |
language (required) | string | |
status | string — one of draft, published, archived | |
categoryId | string | |
tag | string | |
query | string | Full-text search over title and body. |
limit | integer | Default 25. |
offset | integer |
get_article
Get one article with its Markdown body, status and translations.
Requires articles:read · reads
| Argument | Type | Description |
|---|---|---|
id (required) | string |
create_article
Create an article as a draft. It is not visible publicly until published.
Requires articles:write · writes
| Argument | Type | Description |
|---|---|---|
language (required) | string | |
categoryId | string | |
slug (required) | string | |
title (required) | string | |
excerpt | string | |
bodyMarkdown (required) | string | |
seoTitle | string | |
seoDescription | string | |
tags | string[] | |
position | integer | |
kbId (required) | string |
update_article
Change an article. Only the fields given change; pass null to clear an optional field. A published article changes live, which needs publish access.
Requires articles:write · writes
| Argument | Type | Description |
|---|---|---|
categoryId | string | |
slug | string | |
title | string | |
excerpt | string | |
bodyMarkdown | string | |
seoTitle | string | |
seoDescription | string | |
tags | string[] | |
position | integer | |
id (required) | string |
delete_article
Delete an article permanently. Deleting a published article needs publish access.
Requires articles:write · deletes
| Argument | Type | Description |
|---|---|---|
id (required) | string |
create_article_translation
Create the translation of an existing article in another language of the same knowledge base, as a draft.
Requires articles:write · writes
| Argument | Type | Description |
|---|---|---|
language (required) | string | |
categoryId | string | |
slug (required) | string | |
title (required) | string | |
excerpt | string | |
bodyMarkdown (required) | string | |
seoTitle | string | |
seoDescription | string | |
tags | string[] | |
position | integer | |
sourceArticleId (required) | string |
publish_article
Make an article public on the knowledge base site.
Requires articles:publish · writes
| Argument | Type | Description |
|---|---|---|
id (required) | string |
unpublish_article
Take a published article off the public site; it becomes a draft again.
Requires articles:publish · deletes
| Argument | Type | Description |
|---|---|---|
id (required) | string |
archive_article
Archive an article: hidden from the public site and from default lists, kept for reference.
Requires articles:publish · deletes
| Argument | Type | Description |
|---|---|---|
id (required) | string |
import_media_from_url
Copy an image or document from a public https URL into this account’s media, and get back a url to use in article Markdown. Images up to 10 MB, documents up to 25 MB.
Requires articles:write · writes
| Argument | Type | Description |
|---|---|---|
url (required) | string | |
filename | string | Defaults to the last segment of the URL. |
upload_media
Upload an image or document as base64 and get back a url to use in article Markdown. The filename extension must match the content type.
Requires articles:write · writes
| Argument | Type | Description |
|---|---|---|
filename (required) | string | |
contentType (required) | string | e.g. 'image/png' |
base64 (required) | string |
list_products
List products. The products this key may use. A product is the level above a knowledge base, an inbox and a CRM; every CRM and ticket operation is addressed to one. Any key may call this.
Requires kb:read · reads
list_custom_fields
List custom fields. The extra fields defined for contacts, clients, catalog items, orders and subscriptions, and the keys their `custom` values use.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
entity | string — one of contact, client, catalog_item, order, subscription |
create_custom_field
Define a custom field.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
entity (required) | string — one of contact, client, catalog_item, order, subscription | |
key (required) | string | |
label (required) | string | |
type (required) | string — one of text, number, money, date, boolean, select, multiselect, url | |
options | object[] | |
required | boolean | null | |
filterable | boolean | null | |
onCard | boolean | null |
update_custom_field
Change or archive a custom field.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
label | string | |
type | string — one of text, number, money, date, boolean, select, multiselect, url | |
options | object[] | |
required | boolean | null | |
filterable | boolean | null | |
onCard | boolean | null | |
position | integer | |
archived | boolean | null |
list_contacts
List or search contacts. People: customers, buyers and the contacts of client companies. Newest first, cursor-paginated.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
customKey | string | |
customValue | string | |
search | string | |
tag | string | |
clientId | string |
get_contact
Get a contact.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
find_contact_by_email
Find the contact with an email.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
email (required) | string |
create_contact
Create a contact. Needs a name or an email. An email already on another contact of the product fails with EMAIL_TAKEN.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
name | string | |
emails | string[] | |
phone | string | |
language | string | |
tags | string[] | |
custom | object | |
client | object |
update_contact
Update a contact. Only the fields sent change; `emails` and `tags` replace the whole list.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
name | string | |
emails | string[] | |
phone | string | |
language | string | |
tags | string[] | |
custom | object |
delete_contact
Delete a contact.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
add_contact_email
Add an email to a contact.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
email (required) | string |
merge_contacts
Merge a duplicate contact into another. This contact's emails, client links, orders and subscriptions move to the target, and this contact is deleted.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
targetId (required) | string |
get_contact_also_in
The same person in other products. Contacts in the key's other products that share an email, or that someone linked as the same person.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
link_contacts
Mark a contact in another product as the same person.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
otherProductId (required) | string | |
otherContactId (required) | string |
unlink_contacts
Undo a same-person link.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
otherProductId (required) | string | |
otherContactId (required) | string |
list_clients
List or search clients. Customers that are companies or individuals (accounts, for SaaS), each with its contacts.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
customKey | string | |
customValue | string | |
search | string | |
tag | string | |
kind | string — one of company, individual |
get_client
Get a client.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
create_client
Create a client.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
name (required) | string | |
kind | string — one of company, individual | |
vatNumber | string | |
registrationNumber | string | |
addresses | object[] | |
tags | string[] | |
custom | object | |
contact | object |
update_client
Update a client. Only the fields sent change; `addresses` and `tags` replace the whole list.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
name | string | |
kind | string — one of company, individual | |
vatNumber | string | |
registrationNumber | string | |
addresses | object[] | |
tags | string[] | |
custom | object |
delete_client
Delete a client.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
get_client_also_in
The same company in other products. Clients in the key's other products with the same VAT number.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
link_client_contact
Add a contact to a client.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
contactId (required) | string | |
role | string |
unlink_client_contact
Remove a contact from a client. The contact itself is kept.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
contactId (required) | string |
list_stores
List stores. Where the product sells. Orders belong to a store; customers, orders and tickets can be filtered by it.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string |
create_store
Add a store.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
name (required) | string | |
currency (required) | string | |
baseUrl | string |
update_store
Update a store.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
name | string | |
currency | string | |
baseUrl | string |
delete_store
Delete a store. Refused while the store has orders.
Requires crm:configure · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
list_catalog_items
List products, plans and services. What the product sells. Items with an interval bill on a schedule (plans and recurring products).
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
search | string | |
kind | string — one of product, plan, service | |
storeId | string | |
includeArchived | boolean | string — one of true, false |
get_catalog_item
Get a catalog item.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
create_catalog_item
Add a catalog item.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
name (required) | string | |
sku | string | |
kind | string — one of product, plan, service | |
price | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
storeId | string | |
custom | object | |
archived | boolean | null |
update_catalog_item
Update or archive a catalog item. Catalog items are archived (archived: true), never deleted, so orders and subscriptions keep pointing at them.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
name | string | |
sku | string | |
kind | string — one of product, plan, service | |
price | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
storeId | string | |
custom | object | |
archived | boolean | null |
list_orders
List or search orders. Newest first, cursor-paginated.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
customKey | string | |
customValue | string | |
search | string | |
storeId | string | |
status | string — one of pending, processing, on_hold, shipped, completed, canceled, refunded | |
paymentStatus | string — one of unpaid, partially_paid, paid, refunded, void | |
overdue | boolean | string — one of true, false | |
contactId | string | |
clientId | string | |
subscriptionId | string |
get_order
Get an order with its items, shipments and documents.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
create_order
Record an order or a subscription's invoice. Needs a store, unless `subscriptionId` makes it a subscription's invoice. The number must be unique in its store, or among orders without one (ORDER_NUMBER_TAKEN otherwise).
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
storeId | string | |
number (required) | string | |
contactId | string | |
clientId | string | |
subscriptionId | string | |
periodStart | string | |
periodEnd | string | |
status | string — one of pending, processing, on_hold, shipped, completed, canceled, refunded | |
statusRaw | string | |
paymentStatus | string — one of unpaid, partially_paid, paid, refunded, void | |
paidAt | string | |
dueAt | string | |
currency | string | |
subtotal | string | |
shipping | string | |
tax | string | |
discount | string | |
total | string | |
paymentMethod | string | |
billingAddress | object | |
shippingAddress | object | |
placedAt | string | |
items | object[] | |
custom | object |
update_order
Update an order. Only the fields sent change; `items` replaces every line.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
storeId | string | |
number | string | |
contactId | string | |
clientId | string | |
subscriptionId | string | |
periodStart | string | |
periodEnd | string | |
status | string — one of pending, processing, on_hold, shipped, completed, canceled, refunded | |
statusRaw | string | |
paymentStatus | string — one of unpaid, partially_paid, paid, refunded, void | |
paidAt | string | |
dueAt | string | |
currency | string | |
subtotal | string | |
shipping | string | |
tax | string | |
discount | string | |
total | string | |
paymentMethod | string | |
billingAddress | object | |
shippingAddress | object | |
placedAt | string | |
items | object[] | |
custom | object |
delete_order
Delete an order.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
add_shipment
Add a shipment to an order.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
carrierCode | string | |
carrierName | string | |
trackingNumber | string | |
state | string — one of pending, in_transit, delivered, returned, canceled | |
deliveredAt | string |
update_shipment
Update a shipment.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
shipmentId (required) | string | |
carrierCode | string | |
carrierName | string | |
trackingNumber | string | |
state | string — one of pending, in_transit, delivered, returned, canceled | |
deliveredAt | string |
delete_shipment
Delete a shipment.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
shipmentId (required) | string |
add_order_document
Attach an invoice or credit memo to an order.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
kind (required) | string — one of invoice, credit_memo | |
number | string | |
amount (required) | string | |
reason | string | |
issuedAt | string |
delete_order_document
Remove an invoice or credit memo.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
documentId (required) | string |
list_subscriptions
List subscriptions.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
status | string — one of trialing, active, past_due, paused, canceled | |
ended | boolean | string — one of true, false | |
contactId | string | |
withClients | boolean | string — one of true, false | |
clientId | string | |
storeId | string |
get_subscription
Get a subscription.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
create_subscription
Record a subscription. Belongs to a contact, a client, or both (a contact with a single client gets that client too). A catalogItemId fills the plan name, amount, currency and interval that are not sent.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
contactId | string | |
clientId | string | |
catalogItemId | string | |
storeId | string | |
planName | string | |
status | string — one of trialing, active, past_due, paused, canceled | |
amount | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
seats | integer | |
startedAt | string | |
trialEndsAt | string | |
currentPeriodEnd | string | |
canceledAt | string | |
endsAt | string | |
custom | object |
update_subscription
Update, cancel or renew a subscription. Setting status canceled fills endsAt with the end of the paid period unless endsAt is sent; moving a canceled one back to another status clears it.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
contactId | string | |
clientId | string | |
catalogItemId | string | |
storeId | string | |
planName | string | |
status | string — one of trialing, active, past_due, paused, canceled | |
amount | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
seats | integer | |
startedAt | string | |
trialEndsAt | string | |
currentPeriodEnd | string | |
canceledAt | string | |
endsAt | string | |
custom | object |
delete_subscription
Delete a subscription. Its invoices stay, and no longer name it.
Requires crm:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
sync_store
Create or update a store by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`). Stores are configuration: needs crm:configure.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
name | string | |
currency | string | |
baseUrl | string | |
platform | string — one of manual, magento2, magento1 |
sync_contact
Create or update a contact by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`). A new external id first matches a contact by any of its emails, so people already in the CRM (from tickets, say) are not duplicated. Emails are added, never removed.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
name | string | |
emails | string[] | |
phone | string | |
language | string | |
tags | string[] | |
custom | object | |
clientExternalIds | string[] |
sync_client
Create or update a client by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`). A new external id first matches a client by VAT number.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
name | string | |
kind | string — one of company, individual | |
vatNumber | string | |
registrationNumber | string | |
addresses | object[] | |
tags | string[] | |
custom | object |
sync_catalog_item
Create or update a catalog item by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`). A new external id first matches an item by SKU in the same store.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
name | string | |
sku | string | |
kind | string — one of product, plan, service | |
price | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
storeId | string | |
custom | object | |
archived | boolean | null | |
storeExternalId | string |
sync_order
Create or update an order or invoice by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`). A new external id first matches an order by number in the same store (or among orders without one). Send `subscriptionExternalId` for a subscription's invoice, and `paymentStatus`/`paidAt` to record a payment. `shipments` and `documents` replace what this source sent before.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
storeId | string | |
number | string | |
contactId | string | |
clientId | string | |
subscriptionId | string | |
periodStart | string | |
periodEnd | string | |
status | string — one of pending, processing, on_hold, shipped, completed, canceled, refunded | |
statusRaw | string | |
paymentStatus | string — one of unpaid, partially_paid, paid, refunded, void | |
paidAt | string | |
dueAt | string | |
currency | string | |
subtotal | string | |
shipping | string | |
tax | string | |
discount | string | |
total | string | |
paymentMethod | string | |
billingAddress | object | |
shippingAddress | object | |
placedAt | string | |
items | object[] | |
custom | object | |
storeExternalId | string | |
contactExternalId | string | |
clientExternalId | string | |
subscriptionExternalId | string | |
contactEmail | string | |
contactName | string | |
shipments | object[] | |
documents | object[] |
sync_subscription
Create or update a subscription by its id in your system. Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (`…ExternalId`).
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
externalId (required) | string | |
contactId | string | |
clientId | string | |
catalogItemId | string | |
storeId | string | |
planName | string | |
status | string — one of trialing, active, past_due, paused, canceled | |
amount | string | |
currency | string | |
interval | string — one of day, week, month, year | |
intervalCount | integer | |
seats | integer | |
startedAt | string | |
trialEndsAt | string | |
currentPeriodEnd | string | |
canceledAt | string | |
endsAt | string | |
custom | object | |
storeExternalId | string | |
contactExternalId | string | |
clientExternalId | string | |
catalogItemExternalId | string |
sync_batch
Create or update up to 100 records of any type in one call. Records are applied in order, each on its own: a failing record is rolled back and reported, and the rest still go through, so a record can name one sent earlier in the same batch. Use it to import history page by page. Store records need crm:configure.
Requires crm:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
source (required) | string | |
records (required) | any[] |
get_synced_record
Find a record by its id in your system.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
entity (required) | string — one of stores, contacts, clients, catalog-items, orders, subscriptions | |
source (required) | string | |
externalId (required) | string |
list_integrations
List the shops this product syncs from. With each one’s status, progress and last error.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string |
get_integration
Get a shop integration.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
test_integration
Check a shop’s address and credentials without saving them. Returns the shop’s websites when it answers; CONNECTION_REFUSED or CONNECTION_FAILED otherwise.
Requires crm:configure · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
type (required) | string — one of magento2, magento1 | |
baseUrl (required) | string | |
credentials (required) | object |
create_integration
Connect a shop. The shop is checked first. Its websites become stores, and the first sync starts: the catalog, customers and orders changed within the history chosen, then every 15 minutes.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
type (required) | string — one of magento2, magento1 | |
name (required) | string | |
baseUrl (required) | string | |
credentials (required) | object | |
historyMode (required) | string — one of none, months, full | |
historyMonths | integer |
update_integration
Rename, re-point, replace credentials, pause or resume a shop integration.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
name | string | |
baseUrl | string | |
credentials | object | |
paused | boolean | null |
sync_integration
Sync a shop now. Instead of at the next interval; one stopped by an error is retried.
Requires crm:configure · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
delete_integration
Disconnect a shop. What it synced stays in the CRM.
Requires crm:configure · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
get_customer_insights
A customer's lifetime value, what it owes and its monthly revenue. Pass contactId or clientId.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
contactId | string | |
clientId | string | |
months | integer |
get_crm_overview
Revenue per month, recurring revenue, what is owed and the top customers.
Requires crm:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
months | integer |
list_tickets
List or search tickets. Most recent activity first, cursor-paginated.
Requires tickets:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
first | integer | |
after | string | |
view | string — one of all, unassigned | |
search | string | |
statuses | string | |
priorities | string | |
channelId | string | |
tag | string | |
requesterId | string | |
contactId | string | |
requesterKind | string — one of CUSTOMER, LEAD | |
storeId | string |
get_ticket
Get a ticket with its whole thread.
Requires tickets:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
get_ticket_by_number
Find a ticket by its number.
Requires tickets:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
number (required) | integer |
get_ticket_customer
The ticket's customer: contact, clients, orders and subscriptions. What agents see beside a ticket, from the CRM of its product, including orders whose numbers the customer quoted.
Requires tickets:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |
reply_to_ticket
Reply to the customer. Emailed to the requester from the ticket's channel. Shown in the thread as written by this key.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
body (required) | string | |
solve | boolean |
retry_ticket_reply
Send a failed reply again.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
messageId (required) | string |
add_ticket_note
Add an internal note.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
body (required) | string |
assign_ticket
Assign or unassign a ticket.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
assigneeUserId (required) | string |
set_ticket_status
Change a ticket's status.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
status (required) | string — one of OPEN, PENDING, SOLVED, CLOSED |
set_ticket_priority
Change a ticket's priority.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
priority (required) | string — one of LOW, NORMAL, HIGH, URGENT |
set_ticket_tags
Replace a ticket's tags.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
tags (required) | string[] |
merge_ticket
Merge a ticket into another. This ticket is closed into the target and becomes read-only.
Requires tickets:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
targetTicketId (required) | string |
link_ticket_order
Pin an order to a ticket, or unpin it.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
orderId (required) | string | |
linked | boolean |
list_canned_replies
List canned replies.
Requires tickets:read · reads
| Argument | Type | Description |
|---|---|---|
productId (required) | string |
create_canned_reply
Create a canned reply.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
title (required) | string | |
body (required) | string |
update_canned_reply
Replace a canned reply.
Requires tickets:write · writes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string | |
title (required) | string | |
body (required) | string |
delete_canned_reply
Delete a canned reply.
Requires tickets:write · deletes
| Argument | Type | Description |
|---|---|---|
productId (required) | string | |
id (required) | string |