Alle MCP-Werkzeuge

Jedes Werkzeug des SmartChat-MCP-Servers, nach Bereich sortiert. Claude sieht genau diese Namen, Beschreibungen und Felder.

Die technische Referenz unten ist auf Englisch, genau so, wie Namen und Felder in der API und in Claude erscheinen.

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

Zweistufige Aktionen

Werkzeuge, die senden, planen, einreichen oder löschen, liefern zuerst eine Vorschau und ein confirm_token. Ruf dasselbe Werkzeug mit confirm_token nochmal auf, um es auszuführen. Beim ersten Aufruf passiert nichts.

Contacts

search_contacts · Search contacts

Liest nur

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.

FeldTypPflichtBeschreibung
querystringneinName, phone number or email, or part of it.
max length 100
limitintegerneinMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25

Ruft auf: GET /v1/contacts

get_contact · Get contact

Liest nur

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

FeldTypPflichtBeschreibung
contact_idstringjaID of the contact.
min length 1 · max length 100

Ruft auf: GET /v1/contacts/undefined

create_contact · Create contact

Ändert Daten

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.

FeldTypPflichtBeschreibung
namestringjaFull name or company name.
min length 1 · max length 120
phonestringneinPhone number in international format, e.g. +4915112345678.
max length 40
emailstringneinEmail address.
format email · max length 254
acquisitionstring ("marketing", "service", "automation")neinWhere the contact comes from. Default: marketing.

Ruft auf: POST /v1/contacts

update_contact · Update contact

Sendet, reicht ein oder löscht

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.

FeldTypPflichtBeschreibung
contact_idstringjaID of the contact.
min length 1 · max length 100
namestringneinNew name.
min length 1 · max length 120
phonestringneinNew phone number in international format.
max length 40
emailstringneinNew email address.
format email · max length 254

Ruft auf: PATCH /v1/contacts/undefined

add_contact_tag · Add tag to contact

Ändert Daten

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

FeldTypPflichtBeschreibung
contact_idstringjaID of the contact.
min length 1 · max length 100
tagstringjaThe tag, e.g. 'regular customer'.
min length 1 · max length 60

Ruft auf: POST /v1/contacts/undefined/tags

list_contacts · List contacts

Liest nur

Lists contacts with their opt-in state and tags.

FeldTypPflichtBeschreibung
typestringnein
searchstringnein

Ruft auf: POST /v1/tools/list_contacts

add_contact · Add contact

Ändert Daten

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

FeldTypPflichtBeschreibung
namestringnein
emailstringnein
phonestringnein

Ruft auf: POST /v1/tools/add_contact

resend_optin_confirmation · Resend confirmation

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
contact_idstringja
confirm_tokenstringnein

Ruft auf: POST /v1/tools/resend_optin_confirmation

tag_contacts · Tag contacts

Ändert Daten

Adds tags to one or more contacts.

FeldTypPflichtBeschreibung
tagstringja
contact_idsarray of anyja
grundstringnein

Ruft auf: POST /v1/tools/tag_contacts

untag_contacts · Remove tags

Ändert Daten

Removes tags from one or more contacts.

FeldTypPflichtBeschreibung
tagstringja
contact_idsarray of anyja

Ruft auf: POST /v1/tools/untag_contacts

export_contacts · Export contacts

Liest nur

Exports the contacts as CSV text.

Keine Eingabefelder.

Ruft auf: POST /v1/tools/export_contacts

get_last_import · Get last contact import

Liest nur

Returns the status and result of the last contact import.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_last_import

preview_unconfirmed_contacts · Preview unconfirmed contacts

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/preview_unconfirmed_contacts

resend_to_unconfirmed_contacts · Resend confirmation to all unconfirmed

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
bodyobjectneinSame fields as the app sends (usually none).

Ruft auf: POST /v1/app/resend_to_unconfirmed_contacts

get_optin_queue · Get opt-in queue

Liest nur

Returns confirmation messages that are waiting to be sent.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_optin_queue

send_optin_queue · Send opt-in queue

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/send_optin_queue

unsubscribe_contact · Unsubscribe a contact

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
contact_idstringjaID (contact id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/unsubscribe_contact

remove_contact_tag · Remove a tag from a contact

Ändert Daten

Removes one tag from a contact.

FeldTypPflichtBeschreibung
contact_idstringjaID (contact id).
min length 1 · max length 200
tagstringjaID (tag).
min length 1 · max length 200

Ruft auf: POST /v1/app/remove_contact_tag

delete_contact · Delete a contact

Sendet, reicht ein oder löscht

Deletes a contact completely. Cannot be undone.

FeldTypPflichtBeschreibung
contact_idstringjaID (contact id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_contact

export_all_data · Export all account data

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/export_all_data

Messages and inbox

send_message · Send WhatsApp message

Sendet, reicht ein oder löscht

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.

FeldTypPflichtBeschreibung
contact_idstringjaID of the contact.
min length 1 · max length 100
textstringjaMessage text (maximum 4000 characters).
min length 1 · max length 4000
idempotency_keystringneinOptional 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

Ruft auf: POST /v1/messages

get_send_status · Get template send status

Liest nur

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

FeldTypPflichtBeschreibung
send_idstringjaID of the send.
min length 1 · max length 100

Ruft auf: GET /v1/sends/undefined

list_conversations · List inbox conversations

Liest nur

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

FeldTypPflichtBeschreibung
channelstring ("whatsapp", "email")neinOnly this channel.
limitintegerneinMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegerneinNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

Ruft auf: GET /v1/inbox/conversations

get_conversation_messages · Get conversation messages

Liest nur

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

FeldTypPflichtBeschreibung
conversation_idstringjaID of the conversation.
min length 1 · max length 100
limitintegerneinMaximum number of results (default 25, maximum 100).
min 1 · max 100 · default 25
offsetintegerneinNumber of results to skip, for paging (default 0).
min 0 · max 100000 · default 0

Ruft auf: GET /v1/inbox/conversations/undefined/messages

list_ai_conversations · List SmartChat AI conversations

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_ai_conversations

get_ai_conversation_messages · Read a SmartChat AI conversation

Liest nur

Returns all messages of one SmartChat AI conversation.

FeldTypPflichtBeschreibung
conversation_idstringjaID (conversation id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_ai_conversation_messages

mark_conversation_read · Mark conversation as read

Ändert Daten

Marks an inbox conversation as read.

FeldTypPflichtBeschreibung
conversation_idstringjaID (conversation id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/mark_conversation_read

reply_in_conversation · Reply in an inbox conversation

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
conversation_idstringjaID (conversation id).
min length 1 · max length 200
bodyobjectnein{ text } and optional { media_id } - same fields as the app.

Ruft auf: POST /v1/app/reply_in_conversation

save_reply_as_learned · Save reply as learned answer

Ändert Daten

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

FeldTypPflichtBeschreibung
conversation_idstringjaID (conversation id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/save_reply_as_learned

get_conversation_ai_mode · Get AI mode of a conversation

Liest nur

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

FeldTypPflichtBeschreibung
conversation_idstringjaID (conversation id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_conversation_ai_mode

set_conversation_ai_mode · Set AI mode of a conversation

Ändert Daten

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

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

Ruft auf: POST /v1/app/set_conversation_ai_mode

list_learned_answers · List learned answers

Liest nur

Lists the answers the AI reply has learned.

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_learned_answers

update_learned_answer · Change a learned answer

Ändert Daten

Changes one learned answer.

FeldTypPflichtBeschreibung
answer_idstringjaID (answer id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/update_learned_answer

delete_learned_answer · Delete a learned answer

Sendet, reicht ein oder löscht

Deletes one learned answer.

FeldTypPflichtBeschreibung
answer_idstringjaID (answer id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_learned_answer

Newsletters

list_newsletters · List newsletters

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/newsletters

schedule_newsletter · Schedule newsletter

Sendet, reicht ein oder löscht

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.

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

Ruft auf: POST /v1/newsletters/undefined/schedule

create_newsletter · Create newsletter

Ändert DatenKostet Credits wie eine Nachricht an 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.

FeldTypPflichtBeschreibung
subjectstringja
contentstringja
channelstringnein
mediaobjectnein
ctaobjectnein
segmentobjectnein

Ruft auf: POST /v1/tools/create_newsletter

update_newsletter · Change newsletter

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
newsletter_idstringja
subjectstringnein
contentstringnein
mediaanynein
ctaanynein
segmentanynein

Ruft auf: POST /v1/tools/update_newsletter

send_newsletter · Send newsletter now

Sendet, reicht ein oder löscht

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.

FeldTypPflichtBeschreibung
newsletter_idstringja
confirm_tokenstringnein

Ruft auf: POST /v1/tools/send_newsletter

test_newsletter · Send test newsletter

Sendet, reicht ein oder löscht

Sends a newsletter to the test phone number only.

FeldTypPflichtBeschreibung
newsletter_idstringja
tostringnein

Ruft auf: POST /v1/tools/test_newsletter

cancel_newsletter · Cancel newsletter

Sendet, reicht ein oder löscht

Cancels a scheduled newsletter.

FeldTypPflichtBeschreibung
newsletter_idstringja

Ruft auf: POST /v1/tools/cancel_newsletter

get_newsletter · Get newsletter

Liest nur

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

FeldTypPflichtBeschreibung
newsletter_idstringja

Ruft auf: POST /v1/tools/get_newsletter

count_newsletter_recipients · Count newsletter recipients

Liest nur

Returns how many contacts a newsletter would reach.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/count_newsletter_recipients

preview_newsletter · Preview a newsletter

Liest nur

Returns exactly how the newsletter arrives on the phone.

FeldTypPflichtBeschreibung
newsletter_idstringjaID (newsletter id).
min length 1 · max length 200

Ruft auf: POST /v1/app/preview_newsletter

get_newsletter_progress · Get newsletter sending progress

Liest nur

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

FeldTypPflichtBeschreibung
newsletter_idstringjaID (newsletter id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_newsletter_progress

resume_newsletter · Resume a newsletter

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
newsletter_idstringjaID (newsletter id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/resume_newsletter

pause_newsletter · Pause a newsletter

Ändert Daten

Stops a newsletter that is being sent right now.

FeldTypPflichtBeschreibung
newsletter_idstringjaID (newsletter id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/pause_newsletter

delete_newsletter · Delete a newsletter

Sendet, reicht ein oder löscht

Deletes a newsletter from the list.

FeldTypPflichtBeschreibung
newsletter_idstringjaID (newsletter id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_newsletter

get_test_number · Get test phone number

Liest nur

Returns the phone number that receives test newsletters.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_test_number

set_test_number · Set test phone number

Ändert Daten

Sets the phone number that receives test newsletters.

FeldTypPflichtBeschreibung
bodyobjectnein{ phone } in international format.

Ruft auf: POST /v1/app/set_test_number

Templates

send_template · Send approved WhatsApp template

Sendet, reicht ein oder löscht

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.

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

Ruft auf: POST /v1/messages

list_templates · List message templates

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/templates

create_template · Create WhatsApp template draft

Ändert DatenKostet Credits wie eine Nachricht an 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).

FeldTypPflichtBeschreibung
namestringjaInternal template name.
min length 1 · max length 120
textstringjaTemplate text (WhatsApp allows at most 1024 characters).
min length 1 · max length 1024
languagestringneinLanguage 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

Ruft auf: POST /v1/templates

submit_template · Submit template to WhatsApp

Ändert Daten

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.

FeldTypPflichtBeschreibung
template_idstringjaID of the template.
min length 1 · max length 100

Ruft auf: POST /v1/templates/undefined/submit

update_template · Change template

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
template_idstringja
namestringnein
contentstringnein
subjectstringnein
buttonsanynein
mediaanynein
verbatimarray of stringnein

Ruft auf: POST /v1/tools/update_template

delete_template · Delete template

Sendet, reicht ein oder löscht

Deletes a template.

FeldTypPflichtBeschreibung
template_idstringja

Ruft auf: POST /v1/tools/delete_template

submit_all_templates · Submit all templates

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
confirm_tokenstringnein

Ruft auf: POST /v1/tools/submit_all_templates

Follow-ups

create_followup_sequence · Create follow-up sequence

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
namestringja
stepsarray of objectja
activatebooleannein
verbatimarray of stringnein

Ruft auf: POST /v1/tools/create_followup_sequence

update_followup_step · Change follow-up step

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
step_idstringja
contentstringnein
subjectstringnein
delay_hoursnumbernein
verbatimarray of stringnein

Ruft auf: POST /v1/tools/update_followup_step

add_followup_step · Add follow-up step

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

Adds a message to a follow-up sequence.

FeldTypPflichtBeschreibung
sequence_idstringja
channelstringnein
delay_hoursnumbernein
contentstringja
buttonanynein
mediaobjectnein
verbatimarray of stringnein

Ruft auf: POST /v1/tools/add_followup_step

delete_followup_step · Delete follow-up step

Sendet, reicht ein oder löscht

Deletes one message from a follow-up sequence.

FeldTypPflichtBeschreibung
step_idstringja

Ruft auf: POST /v1/tools/delete_followup_step

rename_followup_sequence · Rename follow-up sequence

Ändert Daten

Renames a follow-up sequence.

FeldTypPflichtBeschreibung
sequence_idstringja
namestringja

Ruft auf: POST /v1/tools/rename_followup_sequence

set_followup_status · Pause or start follow-ups

Ändert Daten

Pauses or starts a follow-up sequence.

FeldTypPflichtBeschreibung
sequence_idstringja
statusstring ("active", "paused")ja

Ruft auf: POST /v1/tools/set_followup_status

Automations

list_automations · List automations

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/automations

trigger_automation · Run automation

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
automation_idstringjaID of the automation.
min length 1 · max length 100

Ruft auf: POST /v1/automations/undefined/trigger

create_automation · Create automation

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

Creates an automation (trigger and actions).

FeldTypPflichtBeschreibung
namestringja
trigger_typestringja
trigger_configobjectnein
actionsarray of objectja
contact_fieldsarray of stringnein
activatebooleannein

Ruft auf: POST /v1/tools/create_automation

update_automation · Change automation

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

Changes an automation, or pauses and activates it.

FeldTypPflichtBeschreibung
automation_idstringja
namestringnein
statusstringnein
actionsanynein
trigger_configanynein

Ruft auf: POST /v1/tools/update_automation

test_automation · Test automation

Ändert Daten

Runs an automation once with test data.

FeldTypPflichtBeschreibung
automation_idstringja
sample_payloadobjectnein

Ruft auf: POST /v1/tools/test_automation

get_automation_setup · Get automation setup

Liest nur

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

FeldTypPflichtBeschreibung
automation_idstringja

Ruft auf: POST /v1/tools/get_automation_setup

connect_calendar · Connect calendar

Ändert Daten

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

FeldTypPflichtBeschreibung
automation_idstringja
calendar_urlstringnein
providerstringnein
lead_minutesnumbernein

Ruft auf: POST /v1/tools/connect_calendar

get_automation_runs · Get automation runs

Liest nur

Returns the latest runs of an automation.

FeldTypPflichtBeschreibung
automation_idstringja
limitnumbernein

Ruft auf: POST /v1/tools/get_automation_runs

delete_automation · Delete automation

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
automation_idstringja
confirm_tokenstringnein

Ruft auf: POST /v1/tools/delete_automation

create_free_automation · Create custom automation

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
namestringja
regelobjectja
actionsarray of objectja
contact_fieldsarray of stringnein
activatebooleannein
confirmedbooleannein

Ruft auf: POST /v1/tools/create_free_automation

get_automation_connection · Get automation connection status

Liest nur

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

FeldTypPflichtBeschreibung
automation_idstringjaID (automation id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_automation_connection

get_automation_endpoint · Get automation endpoint

Liest nur

Returns the webhook address and setup of an automation.

FeldTypPflichtBeschreibung
automation_idstringjaID (automation id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_automation_endpoint

get_automation_timeline · Get automation timeline

Liest nur

Returns the timeline of what an automation did.

FeldTypPflichtBeschreibung
automation_idstringjaID (automation id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_automation_timeline

check_automation_calendar · Check automation calendar

Ändert Daten

Checks the connected calendar of an automation.

FeldTypPflichtBeschreibung
automation_idstringjaID (automation id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/check_automation_calendar

get_calendar_guides · Get calendar guides

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_calendar_guides

Landing page and popup

update_landing · Change landing page texts

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
headlinestringnein
subheadlinestringnein
cta_textstringnein
success_messagestringnein
texteobjectnein
steps_titlestringnein
steps_introstringnein
faq_titlestringnein
proof_titlestringnein
problemobjectnein
solutionobjectnein
offerobjectnein
stepsarray of objectnein
faqarray of objectnein
reviewsarray of objectnein
colorstringnein
heading_coloranynein
background_coloranynein
button_coloranynein
fontstringnein
design_moodstringnein
font_pairstringnein
hero_imagestringnein
hero_mediaobjectnein
imagesarray of stringnein
verbatimarray of stringneinNamen 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.

Ruft auf: POST /v1/tools/update_landing

swap_landing_image · Change landing page image

Ändert Daten

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

FeldTypPflichtBeschreibung
positionanyja
querystringnein

Ruft auf: POST /v1/tools/swap_landing_image

get_landing_blocks · Get landing page blocks

Liest nur

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

FeldTypPflichtBeschreibung
positionanynein

Ruft auf: POST /v1/tools/get_landing_blocks

add_landing_block · Add landing page block

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

Adds a block (section) to the landing page.

FeldTypPflichtBeschreibung
typestringja
dataobjectnein
variantstringnein
tonstringnein
positionanynein
stilarray of objectnein

Ruft auf: POST /v1/tools/add_landing_block

remove_landing_block · Remove landing page block

Sendet, reicht ein oder löscht

Removes a block from the landing page.

FeldTypPflichtBeschreibung
positionanyja

Ruft auf: POST /v1/tools/remove_landing_block

move_landing_block · Move landing page block

Ändert Daten

Moves a block to another position on the landing page.

FeldTypPflichtBeschreibung
fromanyja
toanyja

Ruft auf: POST /v1/tools/move_landing_block

set_landing_style · Change landing page style

Ändert Daten

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

FeldTypPflichtBeschreibung
radiusanynein
shadowanynein
spacinganynein
widthanynein
buttonanynein
imageanynein
stilarray of objectnein

Ruft auf: POST /v1/tools/set_landing_style

update_landing_block · Change landing page block

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
positionanyja
karteanynein
dataobjectnein
variantstringnein
tonstringnein
stilarray of objectnein

Ruft auf: POST /v1/tools/update_landing_block

publish_landing · Publish landing page

Sendet, reicht ein oder löscht

Publishes the landing page so the changes are live.

Keine Eingabefelder.

Ruft auf: POST /v1/tools/publish_landing

set_landing_tracking · Set tracking pixel

Ändert Daten

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

FeldTypPflichtBeschreibung
meta_pixel_idstringnein
meta_capi_tokenstringnein
google_idstringnein
gtm_idstringnein
tiktok_idstringnein
tiktok_events_tokenstringnein

Ruft auf: POST /v1/tools/set_landing_tracking

find_text · Find text

Liest nur

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

FeldTypPflichtBeschreibung
textstringja

Ruft auf: POST /v1/tools/find_text

update_website_popup · Change website popup

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
headlinestringnein
textstringnein
buttonstringnein
thanks_headlinestringnein
thanks_textstringnein
imageanynein
triggersarray of string ("time", "exit", "scroll")nein
delay_secondsnumbernein
scroll_percentnumbernein

Ruft auf: POST /v1/tools/update_website_popup

refresh_reviews · Reload reviews

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

Loads the latest Google reviews for the landing page.

Keine Eingabefelder.

Ruft auf: POST /v1/tools/refresh_reviews

get_landing_page · Get landing page

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_landing_page

preview_landing_page · Preview landing page HTML

Liest nur

Returns the rendered HTML of the landing page.

Keine Eingabefelder.

Ruft auf: POST /v1/app/preview_landing_page

unpublish_landing_page · Unpublish landing page

Sendet, reicht ein oder löscht

Takes the landing page offline.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/unpublish_landing_page

get_website_popup · Get website popup

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_website_popup

get_popup_stats · Get popup statistics

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_popup_stats

Media and files

list_media · List media

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/tools/list_media

save_to_library · Save to media library

Ändert Daten

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

FeldTypPflichtBeschreibung
media_idstringja

Ruft auf: POST /v1/tools/save_to_library

delete_media · Delete a media file

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
media_idstringjaID (media id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_media

get_upload_cost · Get upload cost

Liest nur

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

FeldTypPflichtBeschreibung
kindstringneinOptional filter 'kind'.
sizestringneinOptional filter 'size'.

Ruft auf: POST /v1/app/get_upload_cost

get_profile_media · Get profile media

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_profile_media

update_profile_media · Change profile media

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectneinFields as in the app, e.g. { logo_media_id } or { avatar_media_id }.

Ruft auf: POST /v1/app/update_profile_media

list_knowledge_documents · List knowledge documents

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_knowledge_documents

delete_knowledge_document · Delete a knowledge document

Sendet, reicht ein oder löscht

Deletes a knowledge document.

FeldTypPflichtBeschreibung
document_idstringjaID (document id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_knowledge_document

upload_media · Upload image, video or file

Ändert Daten

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.

FeldTypPflichtBeschreibung
urlstringneinPublic address (https) of the file. SmartChat downloads it.
data_base64stringneinThe file itself, base64 encoded (alternative to url, for small files).
filenamestringneinFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringneinOptional file type, e.g. image/jpeg.
usagestringneinOptional purpose: generic, landing, newsletter, template, logo, avatar.

Ruft auf: POST /v1/media

upload_knowledge_document · Upload knowledge document

Ändert Daten

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

FeldTypPflichtBeschreibung
urlstringneinPublic address (https) of the file. SmartChat downloads it.
data_base64stringneinThe file itself, base64 encoded (alternative to url, for small files).
filenamestringneinFile name with extension, e.g. photo.jpg. Required with data_base64.
mimestringneinOptional file type, e.g. image/jpeg.

Ruft auf: POST /v1/knowledge/documents

SmartChat AI and knowledge

ask_smartchat_ai · Ask SmartChat AI

Sendet, reicht ein oder löscht

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.

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

Ruft auf: POST /v1/ai/chat

get_smartchat_ai_reply · Get SmartChat AI reply

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/ai/reply

scan_website · Scan website

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
urlstringja

Ruft auf: POST /v1/tools/scan_website

set_constraint · Set a content rule

Ändert Daten

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

FeldTypPflichtBeschreibung
valuestringja
kindstringnein

Ruft auf: POST /v1/tools/set_constraint

search_knowledge · Search business knowledge

Liest nur

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

FeldTypPflichtBeschreibung
querystringja
limitnumbernein

Ruft auf: POST /v1/tools/search_knowledge

refresh_brain · Rebuild business knowledge

Ändert DatenKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
forcebooleannein

Ruft auf: POST /v1/tools/refresh_brain

get_growth_plan · Get growth plan

Liest nurKostet Credits wie eine Nachricht an SmartChat AI

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

Keine Eingabefelder.

Ruft auf: POST /v1/tools/get_growth_plan

get_next_step · Get next step

Liest nur

Returns the most useful next step for the account.

Keine Eingabefelder.

Ruft auf: POST /v1/tools/get_next_step

web_research · Research on the web

Liest nurKostet Credits wie eine Nachricht an SmartChat AI

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

FeldTypPflichtBeschreibung
querystringja
languagestringnein

Ruft auf: POST /v1/tools/web_research

get_ai_reply_settings · Get AI reply settings

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_ai_reply_settings

update_ai_reply_settings · Change AI reply settings

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectneinFields as in the app, e.g. { enabled, name }.

Ruft auf: POST /v1/app/update_ai_reply_settings

analyze_reply_style · Analyze reply style

Ändert Daten

Analyzes the answer style of the business from past messages.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/analyze_reply_style

approve_reply_style · Approve reply style

Ändert Daten

Approves the analyzed answer style so the AI uses it.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/approve_reply_style

discard_reply_style · Discard reply style

Ändert Daten

Discards the analyzed answer style.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/discard_reply_style

get_auto_reply_faq · Get auto-reply FAQ

Liest nur

Returns the FAQ and settings of the automatic reply.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_auto_reply_faq

update_auto_reply_faq · Change auto-reply FAQ

Ändert Daten

Changes the FAQ and settings of the automatic reply.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/update_auto_reply_faq

Account and settings

get_stats · Get account statistics

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/stats

get_business_profile · Get business profile

Liest nur

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

Keine Eingabefelder.

Ruft auf: GET /v1/settings/profile

get_overview · Get account overview

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/tools/get_overview

update_brand · Change brand

Ändert Daten

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

FeldTypPflichtBeschreibung
colorstringnein
tonalitystringnein

Ruft auf: POST /v1/tools/update_brand

set_whatsapp_profile_photo · Set WhatsApp profile photo

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectnein{ media_id }

Ruft auf: POST /v1/app/set_whatsapp_profile_photo

list_widgets · List website widgets

Liest nur

Lists the website widgets (popup and chat button).

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_widgets

get_widget_snippet · Get widget embed code

Liest nur

Returns the code to paste into the website.

FeldTypPflichtBeschreibung
widget_idstringjaID (widget id).
min length 1 · max length 200

Ruft auf: POST /v1/app/get_widget_snippet

update_widget · Change a widget

Ändert Daten

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

FeldTypPflichtBeschreibung
widget_idstringjaID (widget id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/update_widget

rotate_widget_token · Renew widget token

Sendet, reicht ein oder löscht

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

FeldTypPflichtBeschreibung
widget_idstringjaID (widget id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/rotate_widget_token

get_whatsapp_qr · Get WhatsApp QR code

Liest nur

Returns the QR code for the WhatsApp number.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_whatsapp_qr

get_notifications · Get notification settings

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_notifications

update_notifications · Change notification settings

Ändert Daten

Switches notification emails on or off.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/update_notifications

invite_team_member · Invite a team member

Ändert Daten

Invites a person to the team by email.

FeldTypPflichtBeschreibung
bodyobjectnein{ email, role } - same fields as the app.

Ruft auf: POST /v1/app/invite_team_member

change_team_role · Change a team role

Ändert Daten

Changes the role of a team member.

FeldTypPflichtBeschreibung
member_idstringjaID (member id).
min length 1 · max length 200
bodyobjectnein{ role }

Ruft auf: POST /v1/app/change_team_role

remove_team_member · Remove a team member

Sendet, reicht ein oder löscht

Removes a person from the team.

FeldTypPflichtBeschreibung
member_idstringjaID (member id).
min length 1 · max length 200

Ruft auf: POST /v1/app/remove_team_member

get_billing · Get plan and subscription

Liest nur

Returns the current plan and subscription state.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_billing

list_invoices · List invoices

Liest nur

Lists the invoices of the account.

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_invoices

get_credits · Get credits

Liest nur

Returns the credit balance.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_credits

get_credit_history · Get credit history

Liest nur

Returns the history of credits used and added.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_credit_history

list_rewards · List rewards

Liest nur

Lists the bonus tasks and their state.

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_rewards

claim_reward · Claim a reward

Ändert Daten

Claims a finished bonus task.

FeldTypPflichtBeschreibung
reward_idstringjaID (reward id).
min length 1 · max length 200
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/claim_reward

get_referral · Get referral program

Liest nur

Returns the referral link and its results.

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_referral

list_domains · List domains

Liest nur

Lists the domains and subdomain of the landing page.

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_domains

check_subdomain · Check a subdomain

Liest nur

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

FeldTypPflichtBeschreibung
namestringneinOptional filter 'name'.

Ruft auf: POST /v1/app/check_subdomain

suggest_subdomain · Suggest subdomains

Liest nur

Suggests free subdomains for the business.

Keine Eingabefelder.

Ruft auf: POST /v1/app/suggest_subdomain

set_subdomain · Set the subdomain

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectnein{ name }

Ruft auf: POST /v1/app/set_subdomain

connect_own_domain · Connect an own domain

Ändert Daten

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

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

Ruft auf: POST /v1/app/connect_own_domain

verify_domain · Verify a domain

Ändert Daten

Checks the DNS entries of a connected domain.

FeldTypPflichtBeschreibung
bodyobjectneinFields to send, same as in the app.

Ruft auf: POST /v1/app/verify_domain

set_domain_auto_renew · Switch domain auto-renew

Ändert Daten

Switches the automatic renewal of a domain on or off.

FeldTypPflichtBeschreibung
domain_idstringjaID (domain id).
min length 1 · max length 200
bodyobjectnein{ auto_renew: true|false }

Ruft auf: POST /v1/app/set_domain_auto_renew

delete_domain · Remove a domain

Sendet, reicht ein oder löscht

Removes a connected domain from the account.

FeldTypPflichtBeschreibung
domain_idstringjaID (domain id).
min length 1 · max length 200

Ruft auf: POST /v1/app/delete_domain

list_connected_ai_apps · List connected AI apps

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_connected_ai_apps

list_tutorials · List tutorials

Liest nur

Lists the tutorial videos.

Keine Eingabefelder.

Ruft auf: POST /v1/app/list_tutorials

send_feedback · Send feedback

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectneinSame fields as the app, e.g. { type, message }.

Ruft auf: POST /v1/app/send_feedback

get_onboarding_status · Get setup status

Liest nur

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

Keine Eingabefelder.

Ruft auf: POST /v1/app/get_onboarding_status

set_areas · Choose areas

Ändert Daten

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

FeldTypPflichtBeschreibung
bodyobjectnein{ areas: [...] } - same fields as the app.

Ruft auf: POST /v1/app/set_areas

Fragen?

Schreib uns an support@smartchat.marketing