Tutti gli strumenti MCP

Ogni strumento del server MCP di SmartChat, raggruppato per area. Claude vede esattamente questi nomi, descrizioni e campi.

Il riferimento tecnico qui sotto è in inglese, esattamente come nomi e campi appaiono nell'API e in Claude.

161 tools · MCP server: https://mcp.smartchat.marketing

Azioni in due passi

Gli strumenti che inviano, programmano, sottomettono o eliminano restituiscono prima un'anteprima e un confirm_token. Richiama lo stesso strumento con confirm_token per eseguire. Alla prima chiamata non succede nulla.

Contacts

search_contacts · Search contacts

Solo lettura

Searches the business's contacts by name, phone number or email (partial matches, case-insensitive). Without a query it returns the most recently created contacts. Returns id, name, phone, email, tags and opt-in status.

CampoTipoObbligatorioDescrizione
querystringnoName, phone number or email, or part of it.
max length 100
limitintegernoMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25

Chiama: GET /v1/contacts

get_contact · Get contact

Solo lettura

Returns one contact with all fields, tags and WhatsApp/email opt-in status.

CampoTipoObbligatorioDescrizione
contact_idstringsìID of the contact.
min length 1 · max length 100

Chiama: GET /v1/contacts/undefined

create_contact · Create contact

Modifica dati

Creates a new contact. Needs a phone number or an email address; duplicates are rejected. A new contact starts without marketing consent (opt-in status 'none'), so send_message is not possible until the contact has confirmed the opt-in.

CampoTipoObbligatorioDescrizione
namestringsìFull name or company name.
min length 1 · max length 120
phonestringnoPhone number in international format, e.g. +4915112345678.
max length 40
emailstringnoEmail address.
format email · max length 254
acquisitionstring ("marketing", "service", "automation")noWhere the contact comes from. Default: marketing.

Chiama: POST /v1/contacts

update_contact · Update contact

Invia, sottomette o elimina

Changes name, phone number or email of an existing contact. Only the fields sent are changed. Changing the phone number or email resets the opt-in for that channel.

CampoTipoObbligatorioDescrizione
contact_idstringsìID of the contact.
min length 1 · max length 100
namestringnoNew name.
min length 1 · max length 120
phonestringnoNew phone number in international format.
max length 40
emailstringnoNew email address.
format email · max length 254

Chiama: PATCH /v1/contacts/undefined

add_contact_tag · Add tag to contact

Modifica dati

Adds a tag (label such as 'regular customer') to a contact. Adding a tag that is already there changes nothing.

CampoTipoObbligatorioDescrizione
contact_idstringsìID of the contact.
min length 1 · max length 100
tagstringsìThe tag, e.g. 'regular customer'.
min length 1 · max length 60

Chiama: POST /v1/contacts/undefined/tags

list_contacts · List contacts

Solo lettura

Lists contacts with their opt-in state and tags.

CampoTipoObbligatorioDescrizione
typestringno
searchstringno

Chiama: POST /v1/tools/list_contacts

add_contact · Add contact

Modifica dati

Adds a contact. A new contact still has to confirm the sign-up.

CampoTipoObbligatorioDescrizione
namestringno
emailstringno
phonestringno

Chiama: POST /v1/tools/add_contact

resend_optin_confirmation · Resend confirmation

Invia, sottomette o elimina

Sends the sign-up confirmation to a contact again. First call returns a preview and confirm_token.

CampoTipoObbligatorioDescrizione
contact_idstringsì
confirm_tokenstringno

Chiama: POST /v1/tools/resend_optin_confirmation

tag_contacts · Tag contacts

Modifica dati

Adds tags to one or more contacts.

CampoTipoObbligatorioDescrizione
tagstringsì
contact_idsarray of anysì
grundstringno

Chiama: POST /v1/tools/tag_contacts

untag_contacts · Remove tags

Modifica dati

Removes tags from one or more contacts.

CampoTipoObbligatorioDescrizione
tagstringsì
contact_idsarray of anysì

Chiama: POST /v1/tools/untag_contacts

export_contacts · Export contacts

Solo lettura

Exports the contacts as CSV text.

Nessun campo di input.

Chiama: POST /v1/tools/export_contacts

get_last_import · Get last contact import

Solo lettura

Returns the status and result of the last contact import.

Nessun campo di input.

Chiama: POST /v1/app/get_last_import

preview_unconfirmed_contacts · Preview unconfirmed contacts

Solo lettura

Shows how many contacts have not confirmed their WhatsApp sign-up yet and would get the confirmation again.

Nessun campo di input.

Chiama: POST /v1/app/preview_unconfirmed_contacts

resend_to_unconfirmed_contacts · Resend confirmation to all unconfirmed

Invia, sottomette o elimina

Sends the confirmation message again to all contacts who have not confirmed yet. Sends real WhatsApp messages.

CampoTipoObbligatorioDescrizione
bodyobjectnoSame fields as the app sends (usually none).

Chiama: POST /v1/app/resend_to_unconfirmed_contacts

get_optin_queue · Get opt-in queue

Solo lettura

Returns confirmation messages that are waiting to be sent.

Nessun campo di input.

Chiama: POST /v1/app/get_optin_queue

send_optin_queue · Send opt-in queue

Invia, sottomette o elimina

Sends the waiting confirmation messages now. Sends real WhatsApp messages.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/send_optin_queue

unsubscribe_contact · Unsubscribe a contact

Invia, sottomette o elimina

Unsubscribes a contact: they get no more marketing messages. contact_id from search_contacts.

CampoTipoObbligatorioDescrizione
contact_idstringsìID (contact id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/unsubscribe_contact

remove_contact_tag · Remove a tag from a contact

Modifica dati

Removes one tag from a contact.

CampoTipoObbligatorioDescrizione
contact_idstringsìID (contact id).
min length 1 · max length 200
tagstringsìID (tag).
min length 1 · max length 200

Chiama: POST /v1/app/remove_contact_tag

delete_contact · Delete a contact

Invia, sottomette o elimina

Deletes a contact completely. Cannot be undone.

CampoTipoObbligatorioDescrizione
contact_idstringsìID (contact id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_contact

export_all_data · Export all account data

Solo lettura

Returns the complete data export of the account (as in Settings).

Nessun campo di input.

Chiama: POST /v1/app/export_all_data

Messages and inbox

send_message · Send WhatsApp message

Invia, sottomette o elimina

Sends a free-text WhatsApp message to one contact. Only works for contacts with a confirmed WhatsApp opt-in; otherwise the send is rejected with the reason. Counts against the monthly message quota. WhatsApp only delivers free text within 24 hours of the contact's last message; outside that window use send_template.

CampoTipoObbligatorioDescrizione
contact_idstringsìID of the contact.
min length 1 · max length 100
textstringsìMessage text (maximum 4000 characters).
min length 1 · max length 4000
idempotency_keystringnoOptional unique key for this action (1-255 printable ASCII characters, no spaces). Repeating the call with the same key within 24 hours returns the first result instead of sending again.
min length 1 · max length 255

Chiama: POST /v1/messages

get_send_status · Get template send status

Solo lettura

Returns the status of a template message queued with send_template: queued, sent, delivered, read, failed or skipped (with reason).

CampoTipoObbligatorioDescrizione
send_idstringsìID of the send.
min length 1 · max length 100

Chiama: GET /v1/sends/undefined

list_conversations · List inbox conversations

Solo lettura

Lists inbox conversations (WhatsApp and email), newest first, with contact and last message preview.

CampoTipoObbligatorioDescrizione
channelstring ("whatsapp", "email")noOnly this channel.
limitintegernoMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegernoNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

Chiama: GET /v1/inbox/conversations

get_conversation_messages · Get conversation messages

Solo lettura

Returns the most recent messages of one conversation in chronological order. Use offset to page further back.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID of the conversation.
min length 1 · max length 100
limitintegernoMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegernoNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

Chiama: GET /v1/inbox/conversations/undefined/messages

list_ai_conversations · List SmartChat AI conversations

Solo lettura

Lists the conversations with SmartChat AI (the chat inside the app).

Nessun campo di input.

Chiama: POST /v1/app/list_ai_conversations

get_ai_conversation_messages · Read a SmartChat AI conversation

Solo lettura

Returns all messages of one SmartChat AI conversation.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200

Chiama: POST /v1/app/get_ai_conversation_messages

mark_conversation_read · Mark conversation as read

Modifica dati

Marks an inbox conversation as read.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/mark_conversation_read

reply_in_conversation · Reply in an inbox conversation

Invia, sottomette o elimina

Sends a reply inside an inbox conversation (text, or an image/video from the media library). Sends a real WhatsApp message.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200
bodyobjectno{ text } and optional { media_id } - same fields as the app.

Chiama: POST /v1/app/reply_in_conversation

save_reply_as_learned · Save reply as learned answer

Modifica dati

Saves an answer from a conversation so the AI reply uses it next time.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/save_reply_as_learned

get_conversation_ai_mode · Get AI mode of a conversation

Solo lettura

Returns whether the AI answers in this conversation or a human took over.

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200

Chiama: POST /v1/app/get_conversation_ai_mode

set_conversation_ai_mode · Set AI mode of a conversation

Modifica dati

Switches the AI reply on or off for one conversation (take over / hand back).

CampoTipoObbligatorioDescrizione
conversation_idstringsìID (conversation id).
min length 1 · max length 200
bodyobjectno{ enabled: true|false } - same fields as the app.

Chiama: POST /v1/app/set_conversation_ai_mode

list_learned_answers · List learned answers

Solo lettura

Lists the answers the AI reply has learned.

Nessun campo di input.

Chiama: POST /v1/app/list_learned_answers

update_learned_answer · Change a learned answer

Modifica dati

Changes one learned answer.

CampoTipoObbligatorioDescrizione
answer_idstringsìID (answer id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/update_learned_answer

delete_learned_answer · Delete a learned answer

Invia, sottomette o elimina

Deletes one learned answer.

CampoTipoObbligatorioDescrizione
answer_idstringsìID (answer id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_learned_answer

Newsletters

list_newsletters · List newsletters

Solo lettura

Lists newsletters with status (draft, scheduled, sending, sent) and scheduled time.

Nessun campo di input.

Chiama: GET /v1/newsletters

schedule_newsletter · Schedule newsletter

Invia, sottomette o elimina

Schedules an existing newsletter for a future time. At that time it is sent to all opted-in recipients. Sending immediately is not available through this server.

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID of the newsletter.
min length 1 · max length 100
scheduled_atstringsìSend time in ISO 8601 with time zone, e.g. 2026-10-01T10:00:00Z.
format date-time · max length 40

Chiama: POST /v1/newsletters/undefined/schedule

create_newsletter · Create newsletter

Modifica datiUsa crediti come un messaggio a SmartChat AI

Creates a WhatsApp newsletter as draft. Texts are used word for word; media_id adds an image or video from the media library.

CampoTipoObbligatorioDescrizione
subjectstringsì
contentstringsì
channelstringno
mediaobjectno
ctaobjectno
segmentobjectno

Chiama: POST /v1/tools/create_newsletter

update_newsletter · Change newsletter

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes text, image, video or button of a newsletter. Texts are used word for word.

CampoTipoObbligatorioDescrizione
newsletter_idstringsì
subjectstringno
contentstringno
mediaanyno
ctaanyno
segmentanyno

Chiama: POST /v1/tools/update_newsletter

send_newsletter · Send newsletter now

Invia, sottomette o elimina

Sends a newsletter to all confirmed contacts. First call returns the number of recipients and a confirm_token; the second call with confirm_token sends.

CampoTipoObbligatorioDescrizione
newsletter_idstringsì
confirm_tokenstringno

Chiama: POST /v1/tools/send_newsletter

test_newsletter · Send test newsletter

Invia, sottomette o elimina

Sends a newsletter to the test phone number only.

CampoTipoObbligatorioDescrizione
newsletter_idstringsì
tostringno

Chiama: POST /v1/tools/test_newsletter

cancel_newsletter · Cancel newsletter

Invia, sottomette o elimina

Cancels a scheduled newsletter.

CampoTipoObbligatorioDescrizione
newsletter_idstringsì

Chiama: POST /v1/tools/cancel_newsletter

get_newsletter · Get newsletter

Solo lettura

Returns one newsletter with text, media, state and recipients.

CampoTipoObbligatorioDescrizione
newsletter_idstringsì

Chiama: POST /v1/tools/get_newsletter

count_newsletter_recipients · Count newsletter recipients

Solo lettura

Returns how many contacts a newsletter would reach.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/count_newsletter_recipients

preview_newsletter · Preview a newsletter

Solo lettura

Returns exactly how the newsletter arrives on the phone.

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID (newsletter id).
min length 1 · max length 200

Chiama: POST /v1/app/preview_newsletter

get_newsletter_progress · Get newsletter sending progress

Solo lettura

Returns the sending state of a newsletter (sent, waiting, stopped).

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID (newsletter id).
min length 1 · max length 200

Chiama: POST /v1/app/get_newsletter_progress

resume_newsletter · Resume a newsletter

Invia, sottomette o elimina

Continues sending a newsletter that stopped (for example after credits ran out). Sends real WhatsApp messages.

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID (newsletter id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/resume_newsletter

pause_newsletter · Pause a newsletter

Modifica dati

Stops a newsletter that is being sent right now.

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID (newsletter id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/pause_newsletter

delete_newsletter · Delete a newsletter

Invia, sottomette o elimina

Deletes a newsletter from the list.

CampoTipoObbligatorioDescrizione
newsletter_idstringsìID (newsletter id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_newsletter

get_test_number · Get test phone number

Solo lettura

Returns the phone number that receives test newsletters.

Nessun campo di input.

Chiama: POST /v1/app/get_test_number

set_test_number · Set test phone number

Modifica dati

Sets the phone number that receives test newsletters.

CampoTipoObbligatorioDescrizione
bodyobjectno{ phone } in international format.

Chiama: POST /v1/app/set_test_number

Templates

send_template · Send approved WhatsApp template

Invia, sottomette o elimina

Sends an approved WhatsApp message template to one contact. Works outside the 24-hour window. Only for contacts with a confirmed WhatsApp opt-in and only for templates with status 'approved' (see list_templates, field 'sendable'). Template variables are filled from the contact (name, email, phone and custom fields) and from 'variables'; list_templates shows which variables can be set ('settable_variables'). The message is queued and sent within seconds through the same checks as in the SmartChat app (opt-out list, quota). Returns a send_id for get_send_status and the final text. Counts against the monthly message quota.

CampoTipoObbligatorioDescrizione
contact_idstringsìID of the contact.
min length 1 · max length 100
template_idstringsìID of the template.
min length 1 · max length 100
variablesobjectnoValues for template variables that do not come from the contact, e.g. { "date": "12 October" }. Maximum 20, each at most 1024 characters.
idempotency_keystringnoOptional unique key for this action (1-255 printable ASCII characters, no spaces). Repeating the call with the same key within 24 hours returns the first result instead of sending again.
min length 1 · max length 255

Chiama: POST /v1/messages

list_templates · List message templates

Solo lettura

Lists the message templates with their WhatsApp (Meta) approval status, language, variables, the variables a caller can set ('settable_variables') and whether they can be sent now ('sendable').

Nessun campo di input.

Chiama: GET /v1/templates

create_template · Create WhatsApp template draft

Modifica datiUsa crediti come un messaggio a SmartChat AI

Creates a WhatsApp marketing template as a draft in SmartChat. Nothing is sent to WhatsApp yet; use submit_template to request Meta's approval. Variables are written in double curly braces, e.g. 'Hi {{name}}, your table is ready on {{date}}.' ({{name}} is the contact's first name).

CampoTipoObbligatorioDescrizione
namestringsìInternal template name.
min length 1 · max length 120
textstringsìTemplate text (WhatsApp allows at most 1024 characters).
min length 1 · max length 1024
languagestringnoLanguage of the text as a Meta language code, e.g. en, en_US, de, it, fr, es. Default: the account language.
min length 2 · max length 10

Chiama: POST /v1/templates

submit_template · Submit template to WhatsApp

Modifica dati

Submits a template draft to WhatsApp (Meta) for approval. SmartChat checks the template against Meta's rules first and rejects it with the reason if it would fail. Approval usually takes minutes to a few hours; list_templates shows the status. Changing an approved template later requires a new approval.

CampoTipoObbligatorioDescrizione
template_idstringsìID of the template.
min length 1 · max length 100

Chiama: POST /v1/templates/undefined/submit

update_template · Change template

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes text, image or buttons of a template. Texts are used word for word.

CampoTipoObbligatorioDescrizione
template_idstringsì
namestringno
contentstringno
subjectstringno
buttonsanyno
mediaanyno
verbatimarray of stringno

Chiama: POST /v1/tools/update_template

delete_template · Delete template

Invia, sottomette o elimina

Deletes a template.

CampoTipoObbligatorioDescrizione
template_idstringsì

Chiama: POST /v1/tools/delete_template

submit_all_templates · Submit all templates

Invia, sottomette o elimina

Submits all open templates to WhatsApp. First call returns the list and confirm_token; the second call with confirm_token submits.

CampoTipoObbligatorioDescrizione
confirm_tokenstringno

Chiama: POST /v1/tools/submit_all_templates

Follow-ups

create_followup_sequence · Create follow-up sequence

Modifica datiUsa crediti come un messaggio a SmartChat AI

Creates a follow-up sequence (messages after sign-up).

CampoTipoObbligatorioDescrizione
namestringsì
stepsarray of objectsì
activatebooleanno
verbatimarray of stringno

Chiama: POST /v1/tools/create_followup_sequence

update_followup_step · Change follow-up step

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes text, image or timing of one follow-up message. Texts are used word for word.

CampoTipoObbligatorioDescrizione
step_idstringsì
contentstringno
subjectstringno
delay_hoursnumberno
verbatimarray of stringno

Chiama: POST /v1/tools/update_followup_step

add_followup_step · Add follow-up step

Modifica datiUsa crediti come un messaggio a SmartChat AI

Adds a message to a follow-up sequence.

CampoTipoObbligatorioDescrizione
sequence_idstringsì
channelstringno
delay_hoursnumberno
contentstringsì
buttonanyno
mediaobjectno
verbatimarray of stringno

Chiama: POST /v1/tools/add_followup_step

delete_followup_step · Delete follow-up step

Invia, sottomette o elimina

Deletes one message from a follow-up sequence.

CampoTipoObbligatorioDescrizione
step_idstringsì

Chiama: POST /v1/tools/delete_followup_step

rename_followup_sequence · Rename follow-up sequence

Modifica dati

Renames a follow-up sequence.

CampoTipoObbligatorioDescrizione
sequence_idstringsì
namestringsì

Chiama: POST /v1/tools/rename_followup_sequence

set_followup_status · Pause or start follow-ups

Modifica dati

Pauses or starts a follow-up sequence.

CampoTipoObbligatorioDescrizione
sequence_idstringsì
statusstring ("active", "paused")sì

Chiama: POST /v1/tools/set_followup_status

Automations

list_automations · List automations

Solo lettura

Lists all automations with trigger type and status (active or paused).

Nessun campo di input.

Chiama: GET /v1/automations

trigger_automation · Run automation

Invia, sottomette o elimina

Starts an automation once by hand. Depending on its steps this can send WhatsApp messages or emails to contacts.

CampoTipoObbligatorioDescrizione
automation_idstringsìID of the automation.
min length 1 · max length 100

Chiama: POST /v1/automations/undefined/trigger

create_automation · Create automation

Modifica datiUsa crediti come un messaggio a SmartChat AI

Creates an automation (trigger and actions).

CampoTipoObbligatorioDescrizione
namestringsì
trigger_typestringsì
trigger_configobjectno
actionsarray of objectsì
contact_fieldsarray of stringno
activatebooleanno

Chiama: POST /v1/tools/create_automation

update_automation · Change automation

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes an automation, or pauses and activates it.

CampoTipoObbligatorioDescrizione
automation_idstringsì
namestringno
statusstringno
actionsanyno
trigger_configanyno

Chiama: POST /v1/tools/update_automation

test_automation · Test automation

Modifica dati

Runs an automation once with test data.

CampoTipoObbligatorioDescrizione
automation_idstringsì
sample_payloadobjectno

Chiama: POST /v1/tools/test_automation

get_automation_setup · Get automation setup

Solo lettura

Returns how an automation is connected (webhook address, fields).

CampoTipoObbligatorioDescrizione
automation_idstringsì

Chiama: POST /v1/tools/get_automation_setup

connect_calendar · Connect calendar

Modifica dati

Connects a calendar (private iCal address) to an automation.

CampoTipoObbligatorioDescrizione
automation_idstringsì
calendar_urlstringno
providerstringno
lead_minutesnumberno

Chiama: POST /v1/tools/connect_calendar

get_automation_runs · Get automation runs

Solo lettura

Returns the latest runs of an automation.

CampoTipoObbligatorioDescrizione
automation_idstringsì
limitnumberno

Chiama: POST /v1/tools/get_automation_runs

delete_automation · Delete automation

Invia, sottomette o elimina

Deletes an automation. First call returns a summary and confirm_token.

CampoTipoObbligatorioDescrizione
automation_idstringsì
confirm_tokenstringno

Chiama: POST /v1/tools/delete_automation

create_free_automation · Create custom automation

Modifica datiUsa crediti come un messaggio a SmartChat AI

Creates an automation from a custom rule. First call returns a preview; the second call with confirmed: true creates it.

CampoTipoObbligatorioDescrizione
namestringsì
regelobjectsì
actionsarray of objectsì
contact_fieldsarray of stringno
activatebooleanno
confirmedbooleanno

Chiama: POST /v1/tools/create_free_automation

get_automation_connection · Get automation connection status

Solo lettura

Returns whether an automation receives data (webhook, calendar).

CampoTipoObbligatorioDescrizione
automation_idstringsìID (automation id).
min length 1 · max length 200

Chiama: POST /v1/app/get_automation_connection

get_automation_endpoint · Get automation endpoint

Solo lettura

Returns the webhook address and setup of an automation.

CampoTipoObbligatorioDescrizione
automation_idstringsìID (automation id).
min length 1 · max length 200

Chiama: POST /v1/app/get_automation_endpoint

get_automation_timeline · Get automation timeline

Solo lettura

Returns the timeline of what an automation did.

CampoTipoObbligatorioDescrizione
automation_idstringsìID (automation id).
min length 1 · max length 200

Chiama: POST /v1/app/get_automation_timeline

check_automation_calendar · Check automation calendar

Modifica dati

Checks the connected calendar of an automation.

CampoTipoObbligatorioDescrizione
automation_idstringsìID (automation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/check_automation_calendar

get_calendar_guides · Get calendar guides

Solo lettura

Returns how to find the private calendar address in Google, Outlook and Apple.

Nessun campo di input.

Chiama: POST /v1/app/get_calendar_guides

Landing page and popup

update_landing · Change landing page texts

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes texts and settings of the landing page. Texts are used word for word.

CampoTipoObbligatorioDescrizione
headlinestringno
subheadlinestringno
cta_textstringno
success_messagestringno
texteobjectno
steps_titlestringno
steps_introstringno
faq_titlestringno
proof_titlestringno
problemobjectno
solutionobjectno
offerobjectno
stepsarray of objectno
faqarray of objectno
reviewsarray of objectno
colorstringno
heading_coloranyno
background_coloranyno
button_coloranyno
fontstringno
design_moodstringno
font_pairstringno
hero_imagestringno
hero_mediaobjectno
imagesarray of stringno
verbatimarray of stringnoNamen der Felder, deren Text der Nutzer WÖRTLICH vorgegeben hat (z.B. ["headline"]). Diese Texte werden exakt so gespeichert - ohne Kritiker, ohne Politur. Setze das IMMER, wenn du einen Text übernimmst, den der Nutzer selbst geschrieben hat.

Chiama: POST /v1/tools/update_landing

swap_landing_image · Change landing page image

Modifica dati

Replaces an image on the landing page with an image or video from the media library.

CampoTipoObbligatorioDescrizione
positionanysì
querystringno

Chiama: POST /v1/tools/swap_landing_image

get_landing_blocks · Get landing page blocks

Solo lettura

Returns all blocks of the landing page with their ids and content.

CampoTipoObbligatorioDescrizione
positionanyno

Chiama: POST /v1/tools/get_landing_blocks

add_landing_block · Add landing page block

Modifica datiUsa crediti come un messaggio a SmartChat AI

Adds a block (section) to the landing page.

CampoTipoObbligatorioDescrizione
typestringsì
dataobjectno
variantstringno
tonstringno
positionanyno
stilarray of objectno

Chiama: POST /v1/tools/add_landing_block

remove_landing_block · Remove landing page block

Invia, sottomette o elimina

Removes a block from the landing page.

CampoTipoObbligatorioDescrizione
positionanysì

Chiama: POST /v1/tools/remove_landing_block

move_landing_block · Move landing page block

Modifica dati

Moves a block to another position on the landing page.

CampoTipoObbligatorioDescrizione
fromanysì
toanysì

Chiama: POST /v1/tools/move_landing_block

set_landing_style · Change landing page style

Modifica dati

Changes colors, fonts and background of the landing page or of one block.

CampoTipoObbligatorioDescrizione
radiusanyno
shadowanyno
spacinganyno
widthanyno
buttonanyno
imageanyno
stilarray of objectno

Chiama: POST /v1/tools/set_landing_style

update_landing_block · Change landing page block

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes the content or design of one block. Texts are used word for word.

CampoTipoObbligatorioDescrizione
positionanysì
karteanyno
dataobjectno
variantstringno
tonstringno
stilarray of objectno

Chiama: POST /v1/tools/update_landing_block

publish_landing · Publish landing page

Invia, sottomette o elimina

Publishes the landing page so the changes are live.

Nessun campo di input.

Chiama: POST /v1/tools/publish_landing

set_landing_tracking · Set tracking pixel

Modifica dati

Sets tracking pixels (Meta, Google, TikTok) on the landing page.

CampoTipoObbligatorioDescrizione
meta_pixel_idstringno
meta_capi_tokenstringno
google_idstringno
gtm_idstringno
tiktok_idstringno
tiktok_events_tokenstringno

Chiama: POST /v1/tools/set_landing_tracking

find_text · Find text

Solo lettura

Finds where a text appears: landing page, popup, templates, follow-ups and newsletters. Argument: text.

CampoTipoObbligatorioDescrizione
textstringsì

Chiama: POST /v1/tools/find_text

update_website_popup · Change website popup

Modifica datiUsa crediti come un messaggio a SmartChat AI

Changes texts, look and timing of the sign-up popup on the business website.

CampoTipoObbligatorioDescrizione
headlinestringno
textstringno
buttonstringno
thanks_headlinestringno
thanks_textstringno
imageanyno
triggersarray of string ("time", "exit", "scroll")no
delay_secondsnumberno
scroll_percentnumberno

Chiama: POST /v1/tools/update_website_popup

refresh_reviews · Reload reviews

Modifica datiUsa crediti come un messaggio a SmartChat AI

Loads the latest Google reviews for the landing page.

Nessun campo di input.

Chiama: POST /v1/tools/refresh_reviews

get_landing_page · Get landing page

Solo lettura

Returns the landing page with its settings, address and publish state.

Nessun campo di input.

Chiama: POST /v1/app/get_landing_page

preview_landing_page · Preview landing page HTML

Solo lettura

Returns the rendered HTML of the landing page.

Nessun campo di input.

Chiama: POST /v1/app/preview_landing_page

unpublish_landing_page · Unpublish landing page

Invia, sottomette o elimina

Takes the landing page offline.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/unpublish_landing_page

get_website_popup · Get website popup

Solo lettura

Returns the settings and texts of the website sign-up popup.

Nessun campo di input.

Chiama: POST /v1/app/get_website_popup

get_popup_stats · Get popup statistics

Solo lettura

Returns how often the website popup was seen and how many signed up.

Nessun campo di input.

Chiama: POST /v1/app/get_popup_stats

Media and files

list_media · List media

Solo lettura

Lists the images and videos in the media library with id, number, type and description.

Nessun campo di input.

Chiama: POST /v1/tools/list_media

save_to_library · Save to media library

Modifica dati

Saves an uploaded file permanently to the media library. Argument: media_id.

CampoTipoObbligatorioDescrizione
media_idstringsì

Chiama: POST /v1/tools/save_to_library

delete_media · Delete a media file

Invia, sottomette o elimina

Deletes an image, video or file from the media library. media_id from list_media.

CampoTipoObbligatorioDescrizione
media_idstringsìID (media id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_media

get_upload_cost · Get upload cost

Solo lettura

Returns what an upload costs in credits and time (for example for video processing).

CampoTipoObbligatorioDescrizione
kindstringnoOptional filter 'kind'.
sizestringnoOptional filter 'size'.

Chiama: POST /v1/app/get_upload_cost

get_profile_media · Get profile media

Solo lettura

Returns the profile media: logo and avatar of the business.

Nessun campo di input.

Chiama: POST /v1/app/get_profile_media

update_profile_media · Change profile media

Modifica dati

Sets logo or avatar of the business to an image from the media library.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields as in the app, e.g. { logo_media_id } or { avatar_media_id }.

Chiama: POST /v1/app/update_profile_media

list_knowledge_documents · List knowledge documents

Solo lettura

Lists the documents the AI knows about the business (PDF, text).

Nessun campo di input.

Chiama: POST /v1/app/list_knowledge_documents

delete_knowledge_document · Delete a knowledge document

Invia, sottomette o elimina

Deletes a knowledge document.

CampoTipoObbligatorioDescrizione
document_idstringsìID (document id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_knowledge_document

upload_media · Upload image, video or file

Modifica dati

Uploads an image, video or PDF to the media library, from a public address or as base64. Returns the media id, which can then be used in newsletters, templates, follow-ups and the landing page.

CampoTipoObbligatorioDescrizione
urlstringnoPublic address (https) of the file. SmartChat downloads it.
data_base64stringnoThe file itself, base64 encoded (alternative to url, for small files).
filenamestringnoFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringnoOptional file type, e.g. image/jpeg.
usagestringnoOptional purpose: generic, landing, newsletter, template, logo, avatar.

Chiama: POST /v1/media

upload_knowledge_document · Upload knowledge document

Modifica dati

Uploads a document (PDF, text, Word) the AI reply uses as knowledge about the business, from a public address or as base64.

CampoTipoObbligatorioDescrizione
urlstringnoPublic address (https) of the file. SmartChat downloads it.
data_base64stringnoThe file itself, base64 encoded (alternative to url, for small files).
filenamestringnoFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringnoOptional file type, e.g. image/jpeg.

Chiama: POST /v1/knowledge/documents

SmartChat AI and knowledge

ask_smartchat_ai · Ask SmartChat AI

Invia, sottomette o elimina

Gives a task to SmartChat AI, the assistant inside SmartChat, and returns its answer. Use it for everything the other tools do not cover: create or change WhatsApp newsletters, follow-up sequences, automations, the landing page and the website popup, write message texts, or answer questions about the account. Write the task in plain words, exactly as the user wants it. When SmartChat AI asks for a confirmation (for example before sending or submitting), show the question to the user and call this tool again with the user's answer. If the status is 'working', call get_smartchat_ai_reply after about a minute.

CampoTipoObbligatorioDescrizione
messagestringsìThe task or question for SmartChat AI, in the user's words.
min length 1 · max length 4000

Chiama: POST /v1/ai/chat

get_smartchat_ai_reply · Get SmartChat AI reply

Solo lettura

Returns the latest answer of SmartChat AI. Use it after ask_smartchat_ai returned the status 'working'.

Nessun campo di input.

Chiama: GET /v1/ai/reply

scan_website · Scan website

Modifica datiUsa crediti come un messaggio a SmartChat AI

Scans the business website again and updates the stored data. Argument: url (optional).

CampoTipoObbligatorioDescrizione
urlstringsì

Chiama: POST /v1/tools/scan_website

set_constraint · Set a content rule

Modifica dati

Stores a rule for all content, for example a topic that must never be mentioned.

CampoTipoObbligatorioDescrizione
valuestringsì
kindstringno

Chiama: POST /v1/tools/set_constraint

search_knowledge · Search business knowledge

Solo lettura

Searches the stored knowledge about the business (website, documents). Argument: query.

CampoTipoObbligatorioDescrizione
querystringsì
limitnumberno

Chiama: POST /v1/tools/search_knowledge

refresh_brain · Rebuild business knowledge

Modifica datiUsa crediti come un messaggio a SmartChat AI

Rebuilds the stored knowledge about the business from its website and documents.

CampoTipoObbligatorioDescrizione
forcebooleanno

Chiama: POST /v1/tools/refresh_brain

get_growth_plan · Get growth plan

Solo letturaUsa crediti come un messaggio a SmartChat AI

Returns a growth plan for the business based on its data.

Nessun campo di input.

Chiama: POST /v1/tools/get_growth_plan

get_next_step · Get next step

Solo lettura

Returns the most useful next step for the account.

Nessun campo di input.

Chiama: POST /v1/tools/get_next_step

web_research · Research on the web

Solo letturaUsa crediti come un messaggio a SmartChat AI

Researches a question on the web and returns sources. Argument: query.

CampoTipoObbligatorioDescrizione
querystringsì
languagestringno

Chiama: POST /v1/tools/web_research

get_ai_reply_settings · Get AI reply settings

Solo lettura

Returns the AI reply settings: on/off, name of the AI, delays, confidence.

Nessun campo di input.

Chiama: POST /v1/app/get_ai_reply_settings

update_ai_reply_settings · Change AI reply settings

Modifica dati

Switches the AI reply on or off and changes its name and settings.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields as in the app, e.g. { enabled, name }.

Chiama: POST /v1/app/update_ai_reply_settings

analyze_reply_style · Analyze reply style

Modifica dati

Analyzes the answer style of the business from past messages.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/analyze_reply_style

approve_reply_style · Approve reply style

Modifica dati

Approves the analyzed answer style so the AI uses it.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/approve_reply_style

discard_reply_style · Discard reply style

Modifica dati

Discards the analyzed answer style.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/discard_reply_style

get_auto_reply_faq · Get auto-reply FAQ

Solo lettura

Returns the FAQ and settings of the automatic reply.

Nessun campo di input.

Chiama: POST /v1/app/get_auto_reply_faq

update_auto_reply_faq · Change auto-reply FAQ

Modifica dati

Changes the FAQ and settings of the automatic reply.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/update_auto_reply_faq

Account and settings

get_stats · Get account statistics

Solo lettura

Returns account figures: contacts, messages sent, open conversations and remaining credits.

Nessun campo di input.

Chiama: GET /v1/stats

get_business_profile · Get business profile

Solo lettura

Returns the stored business profile: name, industry, description and website.

Nessun campo di input.

Chiama: GET /v1/settings/profile

get_overview · Get account overview

Solo lettura

Returns an overview of the account: landing page, templates, follow-ups, newsletters, automations and contacts with their IDs and states.

Nessun campo di input.

Chiama: POST /v1/tools/get_overview

update_brand · Change brand

Modifica dati

Changes brand data: name, colors, logo, tone.

CampoTipoObbligatorioDescrizione
colorstringno
tonalitystringno

Chiama: POST /v1/tools/update_brand

set_whatsapp_profile_photo · Set WhatsApp profile photo

Modifica dati

Sets the profile photo of the connected WhatsApp number from an image in the media library.

CampoTipoObbligatorioDescrizione
bodyobjectno{ media_id }

Chiama: POST /v1/app/set_whatsapp_profile_photo

list_widgets · List website widgets

Solo lettura

Lists the website widgets (popup and chat button).

Nessun campo di input.

Chiama: POST /v1/app/list_widgets

get_widget_snippet · Get widget embed code

Solo lettura

Returns the code to paste into the website.

CampoTipoObbligatorioDescrizione
widget_idstringsìID (widget id).
min length 1 · max length 200

Chiama: POST /v1/app/get_widget_snippet

update_widget · Change a widget

Modifica dati

Changes a website widget, for example the WhatsApp number or allowed domains.

CampoTipoObbligatorioDescrizione
widget_idstringsìID (widget id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/update_widget

rotate_widget_token · Renew widget token

Invia, sottomette o elimina

Renews the token of a widget. The old embed code stops working.

CampoTipoObbligatorioDescrizione
widget_idstringsìID (widget id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/rotate_widget_token

get_whatsapp_qr · Get WhatsApp QR code

Solo lettura

Returns the QR code for the WhatsApp number.

Nessun campo di input.

Chiama: POST /v1/app/get_whatsapp_qr

get_notifications · Get notification settings

Solo lettura

Returns which emails the account gets (new messages, problems, reports).

Nessun campo di input.

Chiama: POST /v1/app/get_notifications

update_notifications · Change notification settings

Modifica dati

Switches notification emails on or off.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/update_notifications

invite_team_member · Invite a team member

Modifica dati

Invites a person to the team by email.

CampoTipoObbligatorioDescrizione
bodyobjectno{ email, role } - same fields as the app.

Chiama: POST /v1/app/invite_team_member

change_team_role · Change a team role

Modifica dati

Changes the role of a team member.

CampoTipoObbligatorioDescrizione
member_idstringsìID (member id).
min length 1 · max length 200
bodyobjectno{ role }

Chiama: POST /v1/app/change_team_role

remove_team_member · Remove a team member

Invia, sottomette o elimina

Removes a person from the team.

CampoTipoObbligatorioDescrizione
member_idstringsìID (member id).
min length 1 · max length 200

Chiama: POST /v1/app/remove_team_member

get_billing · Get plan and subscription

Solo lettura

Returns the current plan and subscription state.

Nessun campo di input.

Chiama: POST /v1/app/get_billing

list_invoices · List invoices

Solo lettura

Lists the invoices of the account.

Nessun campo di input.

Chiama: POST /v1/app/list_invoices

get_credits · Get credits

Solo lettura

Returns the credit balance.

Nessun campo di input.

Chiama: POST /v1/app/get_credits

get_credit_history · Get credit history

Solo lettura

Returns the history of credits used and added.

Nessun campo di input.

Chiama: POST /v1/app/get_credit_history

list_rewards · List rewards

Solo lettura

Lists the bonus tasks and their state.

Nessun campo di input.

Chiama: POST /v1/app/list_rewards

claim_reward · Claim a reward

Modifica dati

Claims a finished bonus task.

CampoTipoObbligatorioDescrizione
reward_idstringsìID (reward id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/claim_reward

get_referral · Get referral program

Solo lettura

Returns the referral link and its results.

Nessun campo di input.

Chiama: POST /v1/app/get_referral

list_domains · List domains

Solo lettura

Lists the domains and subdomain of the landing page.

Nessun campo di input.

Chiama: POST /v1/app/list_domains

check_subdomain · Check a subdomain

Solo lettura

Checks if a subdomain (name.smartchat.marketing) is free.

CampoTipoObbligatorioDescrizione
namestringnoOptional filter 'name'.

Chiama: POST /v1/app/check_subdomain

suggest_subdomain · Suggest subdomains

Solo lettura

Suggests free subdomains for the business.

Nessun campo di input.

Chiama: POST /v1/app/suggest_subdomain

set_subdomain · Set the subdomain

Modifica dati

Sets the subdomain of the landing page. The old address stops working.

CampoTipoObbligatorioDescrizione
bodyobjectno{ name }

Chiama: POST /v1/app/set_subdomain

connect_own_domain · Connect an own domain

Modifica dati

Connects a domain the business already owns. Returns the DNS entries to set.

CampoTipoObbligatorioDescrizione
bodyobjectno{ connect: "example.com" } - same fields as the app. Buying a domain is not possible here.

Chiama: POST /v1/app/connect_own_domain

verify_domain · Verify a domain

Modifica dati

Checks the DNS entries of a connected domain.

CampoTipoObbligatorioDescrizione
bodyobjectnoFields to send, same as in the app.

Chiama: POST /v1/app/verify_domain

set_domain_auto_renew · Switch domain auto-renew

Modifica dati

Switches the automatic renewal of a domain on or off.

CampoTipoObbligatorioDescrizione
domain_idstringsìID (domain id).
min length 1 · max length 200
bodyobjectno{ auto_renew: true|false }

Chiama: POST /v1/app/set_domain_auto_renew

delete_domain · Remove a domain

Invia, sottomette o elimina

Removes a connected domain from the account.

CampoTipoObbligatorioDescrizione
domain_idstringsìID (domain id).
min length 1 · max length 200

Chiama: POST /v1/app/delete_domain

list_connected_ai_apps · List connected AI apps

Solo lettura

Lists the AI apps (like Claude) connected to the account.

Nessun campo di input.

Chiama: POST /v1/app/list_connected_ai_apps

list_tutorials · List tutorials

Solo lettura

Lists the tutorial videos.

Nessun campo di input.

Chiama: POST /v1/app/list_tutorials

send_feedback · Send feedback

Modifica dati

Sends feedback, a bug report or a suggestion to the SmartChat team.

CampoTipoObbligatorioDescrizione
bodyobjectnoSame fields as the app, e.g. { type, message }.

Chiama: POST /v1/app/send_feedback

get_onboarding_status · Get setup status

Solo lettura

Returns the setup state of the account (what is done, what is missing).

Nessun campo di input.

Chiama: POST /v1/app/get_onboarding_status

set_areas · Choose areas

Modifica dati

Chooses which areas the account uses (marketing, automations, AI reply).

CampoTipoObbligatorioDescrizione
bodyobjectno{ areas: [...] } - same fields as the app.

Chiama: POST /v1/app/set_areas

Domande?

Scrivici a support@smartchat.marketing