Tous les outils MCP

Chaque outil du serveur MCP de SmartChat, classé par domaine. Claude voit exactement ces noms, descriptions et champs.

La référence technique ci-dessous est en anglais, exactement comme les noms et champs apparaissent dans l'API et dans Claude.

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

Actions en deux étapes

Les outils qui envoient, planifient, soumettent ou suppriment renvoient d'abord un aperçu et un confirm_token. Rappelle le même outil avec confirm_token pour exécuter. Rien ne se passe au premier appel.

Contacts

search_contacts · Search contacts

Lecture seule

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.

ChampTypeObligatoireDescription
querystringnonName, phone number or email, or part of it.
max length 100
limitintegernonMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25

Appelle: GET /v1/contacts

get_contact · Get contact

Lecture seule

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

ChampTypeObligatoireDescription
contact_idstringouiID of the contact.
min length 1 · max length 100

Appelle: GET /v1/contacts/undefined

create_contact · Create contact

Modifie des données

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.

ChampTypeObligatoireDescription
namestringouiFull name or company name.
min length 1 · max length 120
phonestringnonPhone number in international format, e.g. +4915112345678.
max length 40
emailstringnonEmail address.
format email · max length 254
acquisitionstring ("marketing", "service", "automation")nonWhere the contact comes from. Default: marketing.

Appelle: POST /v1/contacts

update_contact · Update contact

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
contact_idstringouiID of the contact.
min length 1 · max length 100
namestringnonNew name.
min length 1 · max length 120
phonestringnonNew phone number in international format.
max length 40
emailstringnonNew email address.
format email · max length 254

Appelle: PATCH /v1/contacts/undefined

add_contact_tag · Add tag to contact

Modifie des données

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

ChampTypeObligatoireDescription
contact_idstringouiID of the contact.
min length 1 · max length 100
tagstringouiThe tag, e.g. 'regular customer'.
min length 1 · max length 60

Appelle: POST /v1/contacts/undefined/tags

list_contacts · List contacts

Lecture seule

Lists contacts with their opt-in state and tags.

ChampTypeObligatoireDescription
typestringnon
searchstringnon

Appelle: POST /v1/tools/list_contacts

add_contact · Add contact

Modifie des données

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

ChampTypeObligatoireDescription
namestringnon
emailstringnon
phonestringnon

Appelle: POST /v1/tools/add_contact

resend_optin_confirmation · Resend confirmation

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
contact_idstringoui
confirm_tokenstringnon

Appelle: POST /v1/tools/resend_optin_confirmation

tag_contacts · Tag contacts

Modifie des données

Adds tags to one or more contacts.

ChampTypeObligatoireDescription
tagstringoui
contact_idsarray of anyoui
grundstringnon

Appelle: POST /v1/tools/tag_contacts

untag_contacts · Remove tags

Modifie des données

Removes tags from one or more contacts.

ChampTypeObligatoireDescription
tagstringoui
contact_idsarray of anyoui

Appelle: POST /v1/tools/untag_contacts

export_contacts · Export contacts

Lecture seule

Exports the contacts as CSV text.

Aucun champ d'entrée.

Appelle: POST /v1/tools/export_contacts

get_last_import · Get last contact import

Lecture seule

Returns the status and result of the last contact import.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_last_import

preview_unconfirmed_contacts · Preview unconfirmed contacts

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/preview_unconfirmed_contacts

resend_to_unconfirmed_contacts · Resend confirmation to all unconfirmed

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
bodyobjectnonSame fields as the app sends (usually none).

Appelle: POST /v1/app/resend_to_unconfirmed_contacts

get_optin_queue · Get opt-in queue

Lecture seule

Returns confirmation messages that are waiting to be sent.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_optin_queue

send_optin_queue · Send opt-in queue

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/send_optin_queue

unsubscribe_contact · Unsubscribe a contact

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
contact_idstringouiID (contact id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/unsubscribe_contact

remove_contact_tag · Remove a tag from a contact

Modifie des données

Removes one tag from a contact.

ChampTypeObligatoireDescription
contact_idstringouiID (contact id).
min length 1 · max length 200
tagstringouiID (tag).
min length 1 · max length 200

Appelle: POST /v1/app/remove_contact_tag

delete_contact · Delete a contact

Envoie, soumet ou supprime

Deletes a contact completely. Cannot be undone.

ChampTypeObligatoireDescription
contact_idstringouiID (contact id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_contact

export_all_data · Export all account data

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/export_all_data

Messages and inbox

send_message · Send WhatsApp message

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
contact_idstringouiID of the contact.
min length 1 · max length 100
textstringouiMessage text (maximum 4000 characters).
min length 1 · max length 4000
idempotency_keystringnonOptional 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

Appelle: POST /v1/messages

get_send_status · Get template send status

Lecture seule

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

ChampTypeObligatoireDescription
send_idstringouiID of the send.
min length 1 · max length 100

Appelle: GET /v1/sends/undefined

list_conversations · List inbox conversations

Lecture seule

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

ChampTypeObligatoireDescription
channelstring ("whatsapp", "email")nonOnly this channel.
limitintegernonMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegernonNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

Appelle: GET /v1/inbox/conversations

get_conversation_messages · Get conversation messages

Lecture seule

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

ChampTypeObligatoireDescription
conversation_idstringouiID of the conversation.
min length 1 · max length 100
limitintegernonMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegernonNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

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

list_ai_conversations · List SmartChat AI conversations

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/list_ai_conversations

get_ai_conversation_messages · Read a SmartChat AI conversation

Lecture seule

Returns all messages of one SmartChat AI conversation.

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200

Appelle: POST /v1/app/get_ai_conversation_messages

mark_conversation_read · Mark conversation as read

Modifie des données

Marks an inbox conversation as read.

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/mark_conversation_read

reply_in_conversation · Reply in an inbox conversation

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200
bodyobjectnon{ text } and optional { media_id } - same fields as the app.

Appelle: POST /v1/app/reply_in_conversation

save_reply_as_learned · Save reply as learned answer

Modifie des données

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

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/save_reply_as_learned

get_conversation_ai_mode · Get AI mode of a conversation

Lecture seule

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

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200

Appelle: POST /v1/app/get_conversation_ai_mode

set_conversation_ai_mode · Set AI mode of a conversation

Modifie des données

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

ChampTypeObligatoireDescription
conversation_idstringouiID (conversation id).
min length 1 · max length 200
bodyobjectnon{ enabled: true|false } - same fields as the app.

Appelle: POST /v1/app/set_conversation_ai_mode

list_learned_answers · List learned answers

Lecture seule

Lists the answers the AI reply has learned.

Aucun champ d'entrée.

Appelle: POST /v1/app/list_learned_answers

update_learned_answer · Change a learned answer

Modifie des données

Changes one learned answer.

ChampTypeObligatoireDescription
answer_idstringouiID (answer id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/update_learned_answer

delete_learned_answer · Delete a learned answer

Envoie, soumet ou supprime

Deletes one learned answer.

ChampTypeObligatoireDescription
answer_idstringouiID (answer id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_learned_answer

Newsletters

list_newsletters · List newsletters

Lecture seule

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

Aucun champ d'entrée.

Appelle: GET /v1/newsletters

schedule_newsletter · Schedule newsletter

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
newsletter_idstringouiID of the newsletter.
min length 1 · max length 100
scheduled_atstringouiSend time in ISO 8601 with time zone, e.g. 2026-10-01T10:00:00Z.
format date-time · max length 40

Appelle: POST /v1/newsletters/undefined/schedule

create_newsletter · Create newsletter

Modifie des donnéesUtilise des crédits comme un message à 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.

ChampTypeObligatoireDescription
subjectstringoui
contentstringoui
channelstringnon
mediaobjectnon
ctaobjectnon
segmentobjectnon

Appelle: POST /v1/tools/create_newsletter

update_newsletter · Change newsletter

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
newsletter_idstringoui
subjectstringnon
contentstringnon
mediaanynon
ctaanynon
segmentanynon

Appelle: POST /v1/tools/update_newsletter

send_newsletter · Send newsletter now

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
newsletter_idstringoui
confirm_tokenstringnon

Appelle: POST /v1/tools/send_newsletter

test_newsletter · Send test newsletter

Envoie, soumet ou supprime

Sends a newsletter to the test phone number only.

ChampTypeObligatoireDescription
newsletter_idstringoui
tostringnon

Appelle: POST /v1/tools/test_newsletter

cancel_newsletter · Cancel newsletter

Envoie, soumet ou supprime

Cancels a scheduled newsletter.

ChampTypeObligatoireDescription
newsletter_idstringoui

Appelle: POST /v1/tools/cancel_newsletter

get_newsletter · Get newsletter

Lecture seule

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

ChampTypeObligatoireDescription
newsletter_idstringoui

Appelle: POST /v1/tools/get_newsletter

count_newsletter_recipients · Count newsletter recipients

Lecture seule

Returns how many contacts a newsletter would reach.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/count_newsletter_recipients

preview_newsletter · Preview a newsletter

Lecture seule

Returns exactly how the newsletter arrives on the phone.

ChampTypeObligatoireDescription
newsletter_idstringouiID (newsletter id).
min length 1 · max length 200

Appelle: POST /v1/app/preview_newsletter

get_newsletter_progress · Get newsletter sending progress

Lecture seule

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

ChampTypeObligatoireDescription
newsletter_idstringouiID (newsletter id).
min length 1 · max length 200

Appelle: POST /v1/app/get_newsletter_progress

resume_newsletter · Resume a newsletter

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
newsletter_idstringouiID (newsletter id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/resume_newsletter

pause_newsletter · Pause a newsletter

Modifie des données

Stops a newsletter that is being sent right now.

ChampTypeObligatoireDescription
newsletter_idstringouiID (newsletter id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/pause_newsletter

delete_newsletter · Delete a newsletter

Envoie, soumet ou supprime

Deletes a newsletter from the list.

ChampTypeObligatoireDescription
newsletter_idstringouiID (newsletter id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_newsletter

get_test_number · Get test phone number

Lecture seule

Returns the phone number that receives test newsletters.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_test_number

set_test_number · Set test phone number

Modifie des données

Sets the phone number that receives test newsletters.

ChampTypeObligatoireDescription
bodyobjectnon{ phone } in international format.

Appelle: POST /v1/app/set_test_number

Templates

send_template · Send approved WhatsApp template

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
contact_idstringouiID of the contact.
min length 1 · max length 100
template_idstringouiID of the template.
min length 1 · max length 100
variablesobjectnonValues for template variables that do not come from the contact, e.g. { "date": "12 October" }. Maximum 20, each at most 1024 characters.
idempotency_keystringnonOptional 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

Appelle: POST /v1/messages

list_templates · List message templates

Lecture seule

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').

Aucun champ d'entrée.

Appelle: GET /v1/templates

create_template · Create WhatsApp template draft

Modifie des donnéesUtilise des crédits comme un message à 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).

ChampTypeObligatoireDescription
namestringouiInternal template name.
min length 1 · max length 120
textstringouiTemplate text (WhatsApp allows at most 1024 characters).
min length 1 · max length 1024
languagestringnonLanguage 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

Appelle: POST /v1/templates

submit_template · Submit template to WhatsApp

Modifie des données

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.

ChampTypeObligatoireDescription
template_idstringouiID of the template.
min length 1 · max length 100

Appelle: POST /v1/templates/undefined/submit

update_template · Change template

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
template_idstringoui
namestringnon
contentstringnon
subjectstringnon
buttonsanynon
mediaanynon
verbatimarray of stringnon

Appelle: POST /v1/tools/update_template

delete_template · Delete template

Envoie, soumet ou supprime

Deletes a template.

ChampTypeObligatoireDescription
template_idstringoui

Appelle: POST /v1/tools/delete_template

submit_all_templates · Submit all templates

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
confirm_tokenstringnon

Appelle: POST /v1/tools/submit_all_templates

Follow-ups

create_followup_sequence · Create follow-up sequence

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
namestringoui
stepsarray of objectoui
activatebooleannon
verbatimarray of stringnon

Appelle: POST /v1/tools/create_followup_sequence

update_followup_step · Change follow-up step

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
step_idstringoui
contentstringnon
subjectstringnon
delay_hoursnumbernon
verbatimarray of stringnon

Appelle: POST /v1/tools/update_followup_step

add_followup_step · Add follow-up step

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

Adds a message to a follow-up sequence.

ChampTypeObligatoireDescription
sequence_idstringoui
channelstringnon
delay_hoursnumbernon
contentstringoui
buttonanynon
mediaobjectnon
verbatimarray of stringnon

Appelle: POST /v1/tools/add_followup_step

delete_followup_step · Delete follow-up step

Envoie, soumet ou supprime

Deletes one message from a follow-up sequence.

ChampTypeObligatoireDescription
step_idstringoui

Appelle: POST /v1/tools/delete_followup_step

rename_followup_sequence · Rename follow-up sequence

Modifie des données

Renames a follow-up sequence.

ChampTypeObligatoireDescription
sequence_idstringoui
namestringoui

Appelle: POST /v1/tools/rename_followup_sequence

set_followup_status · Pause or start follow-ups

Modifie des données

Pauses or starts a follow-up sequence.

ChampTypeObligatoireDescription
sequence_idstringoui
statusstring ("active", "paused")oui

Appelle: POST /v1/tools/set_followup_status

Automations

list_automations · List automations

Lecture seule

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

Aucun champ d'entrée.

Appelle: GET /v1/automations

trigger_automation · Run automation

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
automation_idstringouiID of the automation.
min length 1 · max length 100

Appelle: POST /v1/automations/undefined/trigger

create_automation · Create automation

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

Creates an automation (trigger and actions).

ChampTypeObligatoireDescription
namestringoui
trigger_typestringoui
trigger_configobjectnon
actionsarray of objectoui
contact_fieldsarray of stringnon
activatebooleannon

Appelle: POST /v1/tools/create_automation

update_automation · Change automation

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

Changes an automation, or pauses and activates it.

ChampTypeObligatoireDescription
automation_idstringoui
namestringnon
statusstringnon
actionsanynon
trigger_configanynon

Appelle: POST /v1/tools/update_automation

test_automation · Test automation

Modifie des données

Runs an automation once with test data.

ChampTypeObligatoireDescription
automation_idstringoui
sample_payloadobjectnon

Appelle: POST /v1/tools/test_automation

get_automation_setup · Get automation setup

Lecture seule

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

ChampTypeObligatoireDescription
automation_idstringoui

Appelle: POST /v1/tools/get_automation_setup

connect_calendar · Connect calendar

Modifie des données

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

ChampTypeObligatoireDescription
automation_idstringoui
calendar_urlstringnon
providerstringnon
lead_minutesnumbernon

Appelle: POST /v1/tools/connect_calendar

get_automation_runs · Get automation runs

Lecture seule

Returns the latest runs of an automation.

ChampTypeObligatoireDescription
automation_idstringoui
limitnumbernon

Appelle: POST /v1/tools/get_automation_runs

delete_automation · Delete automation

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
automation_idstringoui
confirm_tokenstringnon

Appelle: POST /v1/tools/delete_automation

create_free_automation · Create custom automation

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
namestringoui
regelobjectoui
actionsarray of objectoui
contact_fieldsarray of stringnon
activatebooleannon
confirmedbooleannon

Appelle: POST /v1/tools/create_free_automation

get_automation_connection · Get automation connection status

Lecture seule

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

ChampTypeObligatoireDescription
automation_idstringouiID (automation id).
min length 1 · max length 200

Appelle: POST /v1/app/get_automation_connection

get_automation_endpoint · Get automation endpoint

Lecture seule

Returns the webhook address and setup of an automation.

ChampTypeObligatoireDescription
automation_idstringouiID (automation id).
min length 1 · max length 200

Appelle: POST /v1/app/get_automation_endpoint

get_automation_timeline · Get automation timeline

Lecture seule

Returns the timeline of what an automation did.

ChampTypeObligatoireDescription
automation_idstringouiID (automation id).
min length 1 · max length 200

Appelle: POST /v1/app/get_automation_timeline

check_automation_calendar · Check automation calendar

Modifie des données

Checks the connected calendar of an automation.

ChampTypeObligatoireDescription
automation_idstringouiID (automation id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/check_automation_calendar

get_calendar_guides · Get calendar guides

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_calendar_guides

Landing page and popup

update_landing · Change landing page texts

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
headlinestringnon
subheadlinestringnon
cta_textstringnon
success_messagestringnon
texteobjectnon
steps_titlestringnon
steps_introstringnon
faq_titlestringnon
proof_titlestringnon
problemobjectnon
solutionobjectnon
offerobjectnon
stepsarray of objectnon
faqarray of objectnon
reviewsarray of objectnon
colorstringnon
heading_coloranynon
background_coloranynon
button_coloranynon
fontstringnon
design_moodstringnon
font_pairstringnon
hero_imagestringnon
hero_mediaobjectnon
imagesarray of stringnon
verbatimarray of stringnonNamen 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.

Appelle: POST /v1/tools/update_landing

swap_landing_image · Change landing page image

Modifie des données

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

ChampTypeObligatoireDescription
positionanyoui
querystringnon

Appelle: POST /v1/tools/swap_landing_image

get_landing_blocks · Get landing page blocks

Lecture seule

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

ChampTypeObligatoireDescription
positionanynon

Appelle: POST /v1/tools/get_landing_blocks

add_landing_block · Add landing page block

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

Adds a block (section) to the landing page.

ChampTypeObligatoireDescription
typestringoui
dataobjectnon
variantstringnon
tonstringnon
positionanynon
stilarray of objectnon

Appelle: POST /v1/tools/add_landing_block

remove_landing_block · Remove landing page block

Envoie, soumet ou supprime

Removes a block from the landing page.

ChampTypeObligatoireDescription
positionanyoui

Appelle: POST /v1/tools/remove_landing_block

move_landing_block · Move landing page block

Modifie des données

Moves a block to another position on the landing page.

ChampTypeObligatoireDescription
fromanyoui
toanyoui

Appelle: POST /v1/tools/move_landing_block

set_landing_style · Change landing page style

Modifie des données

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

ChampTypeObligatoireDescription
radiusanynon
shadowanynon
spacinganynon
widthanynon
buttonanynon
imageanynon
stilarray of objectnon

Appelle: POST /v1/tools/set_landing_style

update_landing_block · Change landing page block

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
positionanyoui
karteanynon
dataobjectnon
variantstringnon
tonstringnon
stilarray of objectnon

Appelle: POST /v1/tools/update_landing_block

publish_landing · Publish landing page

Envoie, soumet ou supprime

Publishes the landing page so the changes are live.

Aucun champ d'entrée.

Appelle: POST /v1/tools/publish_landing

set_landing_tracking · Set tracking pixel

Modifie des données

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

ChampTypeObligatoireDescription
meta_pixel_idstringnon
meta_capi_tokenstringnon
google_idstringnon
gtm_idstringnon
tiktok_idstringnon
tiktok_events_tokenstringnon

Appelle: POST /v1/tools/set_landing_tracking

find_text · Find text

Lecture seule

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

ChampTypeObligatoireDescription
textstringoui

Appelle: POST /v1/tools/find_text

update_website_popup · Change website popup

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
headlinestringnon
textstringnon
buttonstringnon
thanks_headlinestringnon
thanks_textstringnon
imageanynon
triggersarray of string ("time", "exit", "scroll")non
delay_secondsnumbernon
scroll_percentnumbernon

Appelle: POST /v1/tools/update_website_popup

refresh_reviews · Reload reviews

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

Loads the latest Google reviews for the landing page.

Aucun champ d'entrée.

Appelle: POST /v1/tools/refresh_reviews

get_landing_page · Get landing page

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_landing_page

preview_landing_page · Preview landing page HTML

Lecture seule

Returns the rendered HTML of the landing page.

Aucun champ d'entrée.

Appelle: POST /v1/app/preview_landing_page

unpublish_landing_page · Unpublish landing page

Envoie, soumet ou supprime

Takes the landing page offline.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/unpublish_landing_page

get_website_popup · Get website popup

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_website_popup

get_popup_stats · Get popup statistics

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_popup_stats

Media and files

list_media · List media

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/tools/list_media

save_to_library · Save to media library

Modifie des données

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

ChampTypeObligatoireDescription
media_idstringoui

Appelle: POST /v1/tools/save_to_library

delete_media · Delete a media file

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
media_idstringouiID (media id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_media

get_upload_cost · Get upload cost

Lecture seule

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

ChampTypeObligatoireDescription
kindstringnonOptional filter 'kind'.
sizestringnonOptional filter 'size'.

Appelle: POST /v1/app/get_upload_cost

get_profile_media · Get profile media

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_profile_media

update_profile_media · Change profile media

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnonFields as in the app, e.g. { logo_media_id } or { avatar_media_id }.

Appelle: POST /v1/app/update_profile_media

list_knowledge_documents · List knowledge documents

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/list_knowledge_documents

delete_knowledge_document · Delete a knowledge document

Envoie, soumet ou supprime

Deletes a knowledge document.

ChampTypeObligatoireDescription
document_idstringouiID (document id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_knowledge_document

upload_media · Upload image, video or file

Modifie des données

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.

ChampTypeObligatoireDescription
urlstringnonPublic address (https) of the file. SmartChat downloads it.
data_base64stringnonThe file itself, base64 encoded (alternative to url, for small files).
filenamestringnonFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringnonOptional file type, e.g. image/jpeg.
usagestringnonOptional purpose: generic, landing, newsletter, template, logo, avatar.

Appelle: POST /v1/media

upload_knowledge_document · Upload knowledge document

Modifie des données

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

ChampTypeObligatoireDescription
urlstringnonPublic address (https) of the file. SmartChat downloads it.
data_base64stringnonThe file itself, base64 encoded (alternative to url, for small files).
filenamestringnonFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringnonOptional file type, e.g. image/jpeg.

Appelle: POST /v1/knowledge/documents

SmartChat AI and knowledge

ask_smartchat_ai · Ask SmartChat AI

Envoie, soumet ou supprime

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.

ChampTypeObligatoireDescription
messagestringouiThe task or question for SmartChat AI, in the user's words.
min length 1 · max length 4000

Appelle: POST /v1/ai/chat

get_smartchat_ai_reply · Get SmartChat AI reply

Lecture seule

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

Aucun champ d'entrée.

Appelle: GET /v1/ai/reply

scan_website · Scan website

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
urlstringoui

Appelle: POST /v1/tools/scan_website

set_constraint · Set a content rule

Modifie des données

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

ChampTypeObligatoireDescription
valuestringoui
kindstringnon

Appelle: POST /v1/tools/set_constraint

search_knowledge · Search business knowledge

Lecture seule

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

ChampTypeObligatoireDescription
querystringoui
limitnumbernon

Appelle: POST /v1/tools/search_knowledge

refresh_brain · Rebuild business knowledge

Modifie des donnéesUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
forcebooleannon

Appelle: POST /v1/tools/refresh_brain

get_growth_plan · Get growth plan

Lecture seuleUtilise des crédits comme un message à SmartChat AI

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

Aucun champ d'entrée.

Appelle: POST /v1/tools/get_growth_plan

get_next_step · Get next step

Lecture seule

Returns the most useful next step for the account.

Aucun champ d'entrée.

Appelle: POST /v1/tools/get_next_step

web_research · Research on the web

Lecture seuleUtilise des crédits comme un message à SmartChat AI

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

ChampTypeObligatoireDescription
querystringoui
languagestringnon

Appelle: POST /v1/tools/web_research

get_ai_reply_settings · Get AI reply settings

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_ai_reply_settings

update_ai_reply_settings · Change AI reply settings

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnonFields as in the app, e.g. { enabled, name }.

Appelle: POST /v1/app/update_ai_reply_settings

analyze_reply_style · Analyze reply style

Modifie des données

Analyzes the answer style of the business from past messages.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/analyze_reply_style

approve_reply_style · Approve reply style

Modifie des données

Approves the analyzed answer style so the AI uses it.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/approve_reply_style

discard_reply_style · Discard reply style

Modifie des données

Discards the analyzed answer style.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/discard_reply_style

get_auto_reply_faq · Get auto-reply FAQ

Lecture seule

Returns the FAQ and settings of the automatic reply.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_auto_reply_faq

update_auto_reply_faq · Change auto-reply FAQ

Modifie des données

Changes the FAQ and settings of the automatic reply.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/update_auto_reply_faq

Account and settings

get_stats · Get account statistics

Lecture seule

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

Aucun champ d'entrée.

Appelle: GET /v1/stats

get_business_profile · Get business profile

Lecture seule

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

Aucun champ d'entrée.

Appelle: GET /v1/settings/profile

get_overview · Get account overview

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/tools/get_overview

update_brand · Change brand

Modifie des données

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

ChampTypeObligatoireDescription
colorstringnon
tonalitystringnon

Appelle: POST /v1/tools/update_brand

set_whatsapp_profile_photo · Set WhatsApp profile photo

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnon{ media_id }

Appelle: POST /v1/app/set_whatsapp_profile_photo

list_widgets · List website widgets

Lecture seule

Lists the website widgets (popup and chat button).

Aucun champ d'entrée.

Appelle: POST /v1/app/list_widgets

get_widget_snippet · Get widget embed code

Lecture seule

Returns the code to paste into the website.

ChampTypeObligatoireDescription
widget_idstringouiID (widget id).
min length 1 · max length 200

Appelle: POST /v1/app/get_widget_snippet

update_widget · Change a widget

Modifie des données

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

ChampTypeObligatoireDescription
widget_idstringouiID (widget id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/update_widget

rotate_widget_token · Renew widget token

Envoie, soumet ou supprime

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

ChampTypeObligatoireDescription
widget_idstringouiID (widget id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/rotate_widget_token

get_whatsapp_qr · Get WhatsApp QR code

Lecture seule

Returns the QR code for the WhatsApp number.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_whatsapp_qr

get_notifications · Get notification settings

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_notifications

update_notifications · Change notification settings

Modifie des données

Switches notification emails on or off.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/update_notifications

invite_team_member · Invite a team member

Modifie des données

Invites a person to the team by email.

ChampTypeObligatoireDescription
bodyobjectnon{ email, role } - same fields as the app.

Appelle: POST /v1/app/invite_team_member

change_team_role · Change a team role

Modifie des données

Changes the role of a team member.

ChampTypeObligatoireDescription
member_idstringouiID (member id).
min length 1 · max length 200
bodyobjectnon{ role }

Appelle: POST /v1/app/change_team_role

remove_team_member · Remove a team member

Envoie, soumet ou supprime

Removes a person from the team.

ChampTypeObligatoireDescription
member_idstringouiID (member id).
min length 1 · max length 200

Appelle: POST /v1/app/remove_team_member

get_billing · Get plan and subscription

Lecture seule

Returns the current plan and subscription state.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_billing

list_invoices · List invoices

Lecture seule

Lists the invoices of the account.

Aucun champ d'entrée.

Appelle: POST /v1/app/list_invoices

get_credits · Get credits

Lecture seule

Returns the credit balance.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_credits

get_credit_history · Get credit history

Lecture seule

Returns the history of credits used and added.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_credit_history

list_rewards · List rewards

Lecture seule

Lists the bonus tasks and their state.

Aucun champ d'entrée.

Appelle: POST /v1/app/list_rewards

claim_reward · Claim a reward

Modifie des données

Claims a finished bonus task.

ChampTypeObligatoireDescription
reward_idstringouiID (reward id).
min length 1 · max length 200
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/claim_reward

get_referral · Get referral program

Lecture seule

Returns the referral link and its results.

Aucun champ d'entrée.

Appelle: POST /v1/app/get_referral

list_domains · List domains

Lecture seule

Lists the domains and subdomain of the landing page.

Aucun champ d'entrée.

Appelle: POST /v1/app/list_domains

check_subdomain · Check a subdomain

Lecture seule

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

ChampTypeObligatoireDescription
namestringnonOptional filter 'name'.

Appelle: POST /v1/app/check_subdomain

suggest_subdomain · Suggest subdomains

Lecture seule

Suggests free subdomains for the business.

Aucun champ d'entrée.

Appelle: POST /v1/app/suggest_subdomain

set_subdomain · Set the subdomain

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnon{ name }

Appelle: POST /v1/app/set_subdomain

connect_own_domain · Connect an own domain

Modifie des données

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

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

Appelle: POST /v1/app/connect_own_domain

verify_domain · Verify a domain

Modifie des données

Checks the DNS entries of a connected domain.

ChampTypeObligatoireDescription
bodyobjectnonFields to send, same as in the app.

Appelle: POST /v1/app/verify_domain

set_domain_auto_renew · Switch domain auto-renew

Modifie des données

Switches the automatic renewal of a domain on or off.

ChampTypeObligatoireDescription
domain_idstringouiID (domain id).
min length 1 · max length 200
bodyobjectnon{ auto_renew: true|false }

Appelle: POST /v1/app/set_domain_auto_renew

delete_domain · Remove a domain

Envoie, soumet ou supprime

Removes a connected domain from the account.

ChampTypeObligatoireDescription
domain_idstringouiID (domain id).
min length 1 · max length 200

Appelle: POST /v1/app/delete_domain

list_connected_ai_apps · List connected AI apps

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/list_connected_ai_apps

list_tutorials · List tutorials

Lecture seule

Lists the tutorial videos.

Aucun champ d'entrée.

Appelle: POST /v1/app/list_tutorials

send_feedback · Send feedback

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnonSame fields as the app, e.g. { type, message }.

Appelle: POST /v1/app/send_feedback

get_onboarding_status · Get setup status

Lecture seule

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

Aucun champ d'entrée.

Appelle: POST /v1/app/get_onboarding_status

set_areas · Choose areas

Modifie des données

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

ChampTypeObligatoireDescription
bodyobjectnon{ areas: [...] } - same fields as the app.

Appelle: POST /v1/app/set_areas

Des questions ?

Écris-nous à support@smartchat.marketing