Todas las herramientas MCP

Cada herramienta del servidor MCP de SmartChat, agrupada por área. Claude ve exactamente estos nombres, descripciones y campos.

La referencia técnica de abajo está en inglés, exactamente como aparecen los nombres y campos en la API y en Claude.

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

Acciones en dos pasos

Las herramientas que envían, programan, someten o borran devuelven primero una vista previa y un confirm_token. Vuelve a llamar a la misma herramienta con confirm_token para ejecutar. En la primera llamada no pasa nada.

Contacts

search_contacts · Search contacts

Solo lectura

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.

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

Llama a: GET /v1/contacts

get_contact · Get contact

Solo lectura

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

CampoTipoObligatorioDescripción
contact_idstringsíID of the contact.
min length 1 · max length 100

Llama a: GET /v1/contacts/undefined

create_contact · Create contact

Cambia datos

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.

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

Llama a: POST /v1/contacts

update_contact · Update contact

Envía, somete o borra

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.

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

Llama a: PATCH /v1/contacts/undefined

add_contact_tag · Add tag to contact

Cambia datos

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

CampoTipoObligatorioDescripción
contact_idstringsíID of the contact.
min length 1 · max length 100
tagstringsíThe tag, e.g. 'regular customer'.
min length 1 · max length 60

Llama a: POST /v1/contacts/undefined/tags

list_contacts · List contacts

Solo lectura

Lists contacts with their opt-in state and tags.

CampoTipoObligatorioDescripción
typestringno
searchstringno

Llama a: POST /v1/tools/list_contacts

add_contact · Add contact

Cambia datos

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

CampoTipoObligatorioDescripción
namestringno
emailstringno
phonestringno

Llama a: POST /v1/tools/add_contact

resend_optin_confirmation · Resend confirmation

Envía, somete o borra

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

CampoTipoObligatorioDescripción
contact_idstringsí
confirm_tokenstringno

Llama a: POST /v1/tools/resend_optin_confirmation

tag_contacts · Tag contacts

Cambia datos

Adds tags to one or more contacts.

CampoTipoObligatorioDescripción
tagstringsí
contact_idsarray of anysí
grundstringno

Llama a: POST /v1/tools/tag_contacts

untag_contacts · Remove tags

Cambia datos

Removes tags from one or more contacts.

CampoTipoObligatorioDescripción
tagstringsí
contact_idsarray of anysí

Llama a: POST /v1/tools/untag_contacts

export_contacts · Export contacts

Solo lectura

Exports the contacts as CSV text.

Sin campos de entrada.

Llama a: POST /v1/tools/export_contacts

get_last_import · Get last contact import

Solo lectura

Returns the status and result of the last contact import.

Sin campos de entrada.

Llama a: POST /v1/app/get_last_import

preview_unconfirmed_contacts · Preview unconfirmed contacts

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/preview_unconfirmed_contacts

resend_to_unconfirmed_contacts · Resend confirmation to all unconfirmed

Envía, somete o borra

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

CampoTipoObligatorioDescripción
bodyobjectnoSame fields as the app sends (usually none).

Llama a: POST /v1/app/resend_to_unconfirmed_contacts

get_optin_queue · Get opt-in queue

Solo lectura

Returns confirmation messages that are waiting to be sent.

Sin campos de entrada.

Llama a: POST /v1/app/get_optin_queue

send_optin_queue · Send opt-in queue

Envía, somete o borra

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

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/send_optin_queue

unsubscribe_contact · Unsubscribe a contact

Envía, somete o borra

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

CampoTipoObligatorioDescripción
contact_idstringsíID (contact id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/unsubscribe_contact

remove_contact_tag · Remove a tag from a contact

Cambia datos

Removes one tag from a contact.

CampoTipoObligatorioDescripción
contact_idstringsíID (contact id).
min length 1 · max length 200
tagstringsíID (tag).
min length 1 · max length 200

Llama a: POST /v1/app/remove_contact_tag

delete_contact · Delete a contact

Envía, somete o borra

Deletes a contact completely. Cannot be undone.

CampoTipoObligatorioDescripción
contact_idstringsíID (contact id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_contact

export_all_data · Export all account data

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/export_all_data

Messages and inbox

send_message · Send WhatsApp message

Envía, somete o borra

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.

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

Llama a: POST /v1/messages

get_send_status · Get template send status

Solo lectura

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

CampoTipoObligatorioDescripción
send_idstringsíID of the send.
min length 1 · max length 100

Llama a: GET /v1/sends/undefined

list_conversations · List inbox conversations

Solo lectura

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

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

Llama a: GET /v1/inbox/conversations

get_conversation_messages · Get conversation messages

Solo lectura

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

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

Llama a: GET /v1/inbox/conversations/undefined/messages

list_ai_conversations · List SmartChat AI conversations

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/list_ai_conversations

get_ai_conversation_messages · Read a SmartChat AI conversation

Solo lectura

Returns all messages of one SmartChat AI conversation.

CampoTipoObligatorioDescripción
conversation_idstringsíID (conversation id).
min length 1 · max length 200

Llama a: POST /v1/app/get_ai_conversation_messages

mark_conversation_read · Mark conversation as read

Cambia datos

Marks an inbox conversation as read.

CampoTipoObligatorioDescripción
conversation_idstringsíID (conversation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/mark_conversation_read

reply_in_conversation · Reply in an inbox conversation

Envía, somete o borra

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

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

Llama a: POST /v1/app/reply_in_conversation

save_reply_as_learned · Save reply as learned answer

Cambia datos

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

CampoTipoObligatorioDescripción
conversation_idstringsíID (conversation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/save_reply_as_learned

get_conversation_ai_mode · Get AI mode of a conversation

Solo lectura

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

CampoTipoObligatorioDescripción
conversation_idstringsíID (conversation id).
min length 1 · max length 200

Llama a: POST /v1/app/get_conversation_ai_mode

set_conversation_ai_mode · Set AI mode of a conversation

Cambia datos

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

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

Llama a: POST /v1/app/set_conversation_ai_mode

list_learned_answers · List learned answers

Solo lectura

Lists the answers the AI reply has learned.

Sin campos de entrada.

Llama a: POST /v1/app/list_learned_answers

update_learned_answer · Change a learned answer

Cambia datos

Changes one learned answer.

CampoTipoObligatorioDescripción
answer_idstringsíID (answer id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/update_learned_answer

delete_learned_answer · Delete a learned answer

Envía, somete o borra

Deletes one learned answer.

CampoTipoObligatorioDescripción
answer_idstringsíID (answer id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_learned_answer

Newsletters

list_newsletters · List newsletters

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/newsletters

schedule_newsletter · Schedule newsletter

Envía, somete o borra

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.

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

Llama a: POST /v1/newsletters/undefined/schedule

create_newsletter · Create newsletter

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
subjectstringsí
contentstringsí
channelstringno
mediaobjectno
ctaobjectno
segmentobjectno

Llama a: POST /v1/tools/create_newsletter

update_newsletter · Change newsletter

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
newsletter_idstringsí
subjectstringno
contentstringno
mediaanyno
ctaanyno
segmentanyno

Llama a: POST /v1/tools/update_newsletter

send_newsletter · Send newsletter now

Envía, somete o borra

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.

CampoTipoObligatorioDescripción
newsletter_idstringsí
confirm_tokenstringno

Llama a: POST /v1/tools/send_newsletter

test_newsletter · Send test newsletter

Envía, somete o borra

Sends a newsletter to the test phone number only.

CampoTipoObligatorioDescripción
newsletter_idstringsí
tostringno

Llama a: POST /v1/tools/test_newsletter

cancel_newsletter · Cancel newsletter

Envía, somete o borra

Cancels a scheduled newsletter.

CampoTipoObligatorioDescripción
newsletter_idstringsí

Llama a: POST /v1/tools/cancel_newsletter

get_newsletter · Get newsletter

Solo lectura

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

CampoTipoObligatorioDescripción
newsletter_idstringsí

Llama a: POST /v1/tools/get_newsletter

count_newsletter_recipients · Count newsletter recipients

Solo lectura

Returns how many contacts a newsletter would reach.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/count_newsletter_recipients

preview_newsletter · Preview a newsletter

Solo lectura

Returns exactly how the newsletter arrives on the phone.

CampoTipoObligatorioDescripción
newsletter_idstringsíID (newsletter id).
min length 1 · max length 200

Llama a: POST /v1/app/preview_newsletter

get_newsletter_progress · Get newsletter sending progress

Solo lectura

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

CampoTipoObligatorioDescripción
newsletter_idstringsíID (newsletter id).
min length 1 · max length 200

Llama a: POST /v1/app/get_newsletter_progress

resume_newsletter · Resume a newsletter

Envía, somete o borra

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

CampoTipoObligatorioDescripción
newsletter_idstringsíID (newsletter id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/resume_newsletter

pause_newsletter · Pause a newsletter

Cambia datos

Stops a newsletter that is being sent right now.

CampoTipoObligatorioDescripción
newsletter_idstringsíID (newsletter id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/pause_newsletter

delete_newsletter · Delete a newsletter

Envía, somete o borra

Deletes a newsletter from the list.

CampoTipoObligatorioDescripción
newsletter_idstringsíID (newsletter id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_newsletter

get_test_number · Get test phone number

Solo lectura

Returns the phone number that receives test newsletters.

Sin campos de entrada.

Llama a: POST /v1/app/get_test_number

set_test_number · Set test phone number

Cambia datos

Sets the phone number that receives test newsletters.

CampoTipoObligatorioDescripción
bodyobjectno{ phone } in international format.

Llama a: POST /v1/app/set_test_number

Templates

send_template · Send approved WhatsApp template

Envía, somete o borra

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.

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

Llama a: POST /v1/messages

list_templates · List message templates

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/templates

create_template · Create WhatsApp template draft

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

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

Llama a: POST /v1/templates

submit_template · Submit template to WhatsApp

Cambia datos

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.

CampoTipoObligatorioDescripción
template_idstringsíID of the template.
min length 1 · max length 100

Llama a: POST /v1/templates/undefined/submit

update_template · Change template

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
template_idstringsí
namestringno
contentstringno
subjectstringno
buttonsanyno
mediaanyno
verbatimarray of stringno

Llama a: POST /v1/tools/update_template

delete_template · Delete template

Envía, somete o borra

Deletes a template.

CampoTipoObligatorioDescripción
template_idstringsí

Llama a: POST /v1/tools/delete_template

submit_all_templates · Submit all templates

Envía, somete o borra

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

CampoTipoObligatorioDescripción
confirm_tokenstringno

Llama a: POST /v1/tools/submit_all_templates

Follow-ups

create_followup_sequence · Create follow-up sequence

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
namestringsí
stepsarray of objectsí
activatebooleanno
verbatimarray of stringno

Llama a: POST /v1/tools/create_followup_sequence

update_followup_step · Change follow-up step

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
step_idstringsí
contentstringno
subjectstringno
delay_hoursnumberno
verbatimarray of stringno

Llama a: POST /v1/tools/update_followup_step

add_followup_step · Add follow-up step

Cambia datosUsa créditos como un mensaje a SmartChat AI

Adds a message to a follow-up sequence.

CampoTipoObligatorioDescripción
sequence_idstringsí
channelstringno
delay_hoursnumberno
contentstringsí
buttonanyno
mediaobjectno
verbatimarray of stringno

Llama a: POST /v1/tools/add_followup_step

delete_followup_step · Delete follow-up step

Envía, somete o borra

Deletes one message from a follow-up sequence.

CampoTipoObligatorioDescripción
step_idstringsí

Llama a: POST /v1/tools/delete_followup_step

rename_followup_sequence · Rename follow-up sequence

Cambia datos

Renames a follow-up sequence.

CampoTipoObligatorioDescripción
sequence_idstringsí
namestringsí

Llama a: POST /v1/tools/rename_followup_sequence

set_followup_status · Pause or start follow-ups

Cambia datos

Pauses or starts a follow-up sequence.

CampoTipoObligatorioDescripción
sequence_idstringsí
statusstring ("active", "paused")sí

Llama a: POST /v1/tools/set_followup_status

Automations

list_automations · List automations

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/automations

trigger_automation · Run automation

Envía, somete o borra

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

CampoTipoObligatorioDescripción
automation_idstringsíID of the automation.
min length 1 · max length 100

Llama a: POST /v1/automations/undefined/trigger

create_automation · Create automation

Cambia datosUsa créditos como un mensaje a SmartChat AI

Creates an automation (trigger and actions).

CampoTipoObligatorioDescripción
namestringsí
trigger_typestringsí
trigger_configobjectno
actionsarray of objectsí
contact_fieldsarray of stringno
activatebooleanno

Llama a: POST /v1/tools/create_automation

update_automation · Change automation

Cambia datosUsa créditos como un mensaje a SmartChat AI

Changes an automation, or pauses and activates it.

CampoTipoObligatorioDescripción
automation_idstringsí
namestringno
statusstringno
actionsanyno
trigger_configanyno

Llama a: POST /v1/tools/update_automation

test_automation · Test automation

Cambia datos

Runs an automation once with test data.

CampoTipoObligatorioDescripción
automation_idstringsí
sample_payloadobjectno

Llama a: POST /v1/tools/test_automation

get_automation_setup · Get automation setup

Solo lectura

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

CampoTipoObligatorioDescripción
automation_idstringsí

Llama a: POST /v1/tools/get_automation_setup

connect_calendar · Connect calendar

Cambia datos

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

CampoTipoObligatorioDescripción
automation_idstringsí
calendar_urlstringno
providerstringno
lead_minutesnumberno

Llama a: POST /v1/tools/connect_calendar

get_automation_runs · Get automation runs

Solo lectura

Returns the latest runs of an automation.

CampoTipoObligatorioDescripción
automation_idstringsí
limitnumberno

Llama a: POST /v1/tools/get_automation_runs

delete_automation · Delete automation

Envía, somete o borra

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

CampoTipoObligatorioDescripción
automation_idstringsí
confirm_tokenstringno

Llama a: POST /v1/tools/delete_automation

create_free_automation · Create custom automation

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
namestringsí
regelobjectsí
actionsarray of objectsí
contact_fieldsarray of stringno
activatebooleanno
confirmedbooleanno

Llama a: POST /v1/tools/create_free_automation

get_automation_connection · Get automation connection status

Solo lectura

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

CampoTipoObligatorioDescripción
automation_idstringsíID (automation id).
min length 1 · max length 200

Llama a: POST /v1/app/get_automation_connection

get_automation_endpoint · Get automation endpoint

Solo lectura

Returns the webhook address and setup of an automation.

CampoTipoObligatorioDescripción
automation_idstringsíID (automation id).
min length 1 · max length 200

Llama a: POST /v1/app/get_automation_endpoint

get_automation_timeline · Get automation timeline

Solo lectura

Returns the timeline of what an automation did.

CampoTipoObligatorioDescripción
automation_idstringsíID (automation id).
min length 1 · max length 200

Llama a: POST /v1/app/get_automation_timeline

check_automation_calendar · Check automation calendar

Cambia datos

Checks the connected calendar of an automation.

CampoTipoObligatorioDescripción
automation_idstringsíID (automation id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/check_automation_calendar

get_calendar_guides · Get calendar guides

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_calendar_guides

Landing page and popup

update_landing · Change landing page texts

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

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

Llama a: POST /v1/tools/update_landing

swap_landing_image · Change landing page image

Cambia datos

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

CampoTipoObligatorioDescripción
positionanysí
querystringno

Llama a: POST /v1/tools/swap_landing_image

get_landing_blocks · Get landing page blocks

Solo lectura

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

CampoTipoObligatorioDescripción
positionanyno

Llama a: POST /v1/tools/get_landing_blocks

add_landing_block · Add landing page block

Cambia datosUsa créditos como un mensaje a SmartChat AI

Adds a block (section) to the landing page.

CampoTipoObligatorioDescripción
typestringsí
dataobjectno
variantstringno
tonstringno
positionanyno
stilarray of objectno

Llama a: POST /v1/tools/add_landing_block

remove_landing_block · Remove landing page block

Envía, somete o borra

Removes a block from the landing page.

CampoTipoObligatorioDescripción
positionanysí

Llama a: POST /v1/tools/remove_landing_block

move_landing_block · Move landing page block

Cambia datos

Moves a block to another position on the landing page.

CampoTipoObligatorioDescripción
fromanysí
toanysí

Llama a: POST /v1/tools/move_landing_block

set_landing_style · Change landing page style

Cambia datos

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

CampoTipoObligatorioDescripción
radiusanyno
shadowanyno
spacinganyno
widthanyno
buttonanyno
imageanyno
stilarray of objectno

Llama a: POST /v1/tools/set_landing_style

update_landing_block · Change landing page block

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
positionanysí
karteanyno
dataobjectno
variantstringno
tonstringno
stilarray of objectno

Llama a: POST /v1/tools/update_landing_block

publish_landing · Publish landing page

Envía, somete o borra

Publishes the landing page so the changes are live.

Sin campos de entrada.

Llama a: POST /v1/tools/publish_landing

set_landing_tracking · Set tracking pixel

Cambia datos

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

CampoTipoObligatorioDescripción
meta_pixel_idstringno
meta_capi_tokenstringno
google_idstringno
gtm_idstringno
tiktok_idstringno
tiktok_events_tokenstringno

Llama a: POST /v1/tools/set_landing_tracking

find_text · Find text

Solo lectura

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

CampoTipoObligatorioDescripción
textstringsí

Llama a: POST /v1/tools/find_text

update_website_popup · Change website popup

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

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

Llama a: POST /v1/tools/update_website_popup

refresh_reviews · Reload reviews

Cambia datosUsa créditos como un mensaje a SmartChat AI

Loads the latest Google reviews for the landing page.

Sin campos de entrada.

Llama a: POST /v1/tools/refresh_reviews

get_landing_page · Get landing page

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_landing_page

preview_landing_page · Preview landing page HTML

Solo lectura

Returns the rendered HTML of the landing page.

Sin campos de entrada.

Llama a: POST /v1/app/preview_landing_page

unpublish_landing_page · Unpublish landing page

Envía, somete o borra

Takes the landing page offline.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/unpublish_landing_page

get_website_popup · Get website popup

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_website_popup

get_popup_stats · Get popup statistics

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_popup_stats

Media and files

list_media · List media

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/tools/list_media

save_to_library · Save to media library

Cambia datos

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

CampoTipoObligatorioDescripción
media_idstringsí

Llama a: POST /v1/tools/save_to_library

delete_media · Delete a media file

Envía, somete o borra

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

CampoTipoObligatorioDescripción
media_idstringsíID (media id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_media

get_upload_cost · Get upload cost

Solo lectura

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

CampoTipoObligatorioDescripción
kindstringnoOptional filter 'kind'.
sizestringnoOptional filter 'size'.

Llama a: POST /v1/app/get_upload_cost

get_profile_media · Get profile media

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_profile_media

update_profile_media · Change profile media

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectnoFields as in the app, e.g. { logo_media_id } or { avatar_media_id }.

Llama a: POST /v1/app/update_profile_media

list_knowledge_documents · List knowledge documents

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/list_knowledge_documents

delete_knowledge_document · Delete a knowledge document

Envía, somete o borra

Deletes a knowledge document.

CampoTipoObligatorioDescripción
document_idstringsíID (document id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_knowledge_document

upload_media · Upload image, video or file

Cambia datos

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.

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

Llama a: POST /v1/media

upload_knowledge_document · Upload knowledge document

Cambia datos

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

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

Llama a: POST /v1/knowledge/documents

SmartChat AI and knowledge

ask_smartchat_ai · Ask SmartChat AI

Envía, somete o borra

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.

CampoTipoObligatorioDescripción
messagestringsíThe task or question for SmartChat AI, in the user's words.
min length 1 · max length 4000

Llama a: POST /v1/ai/chat

get_smartchat_ai_reply · Get SmartChat AI reply

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/ai/reply

scan_website · Scan website

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
urlstringsí

Llama a: POST /v1/tools/scan_website

set_constraint · Set a content rule

Cambia datos

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

CampoTipoObligatorioDescripción
valuestringsí
kindstringno

Llama a: POST /v1/tools/set_constraint

search_knowledge · Search business knowledge

Solo lectura

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

CampoTipoObligatorioDescripción
querystringsí
limitnumberno

Llama a: POST /v1/tools/search_knowledge

refresh_brain · Rebuild business knowledge

Cambia datosUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
forcebooleanno

Llama a: POST /v1/tools/refresh_brain

get_growth_plan · Get growth plan

Solo lecturaUsa créditos como un mensaje a SmartChat AI

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

Sin campos de entrada.

Llama a: POST /v1/tools/get_growth_plan

get_next_step · Get next step

Solo lectura

Returns the most useful next step for the account.

Sin campos de entrada.

Llama a: POST /v1/tools/get_next_step

web_research · Research on the web

Solo lecturaUsa créditos como un mensaje a SmartChat AI

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

CampoTipoObligatorioDescripción
querystringsí
languagestringno

Llama a: POST /v1/tools/web_research

get_ai_reply_settings · Get AI reply settings

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_ai_reply_settings

update_ai_reply_settings · Change AI reply settings

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectnoFields as in the app, e.g. { enabled, name }.

Llama a: POST /v1/app/update_ai_reply_settings

analyze_reply_style · Analyze reply style

Cambia datos

Analyzes the answer style of the business from past messages.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/analyze_reply_style

approve_reply_style · Approve reply style

Cambia datos

Approves the analyzed answer style so the AI uses it.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/approve_reply_style

discard_reply_style · Discard reply style

Cambia datos

Discards the analyzed answer style.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/discard_reply_style

get_auto_reply_faq · Get auto-reply FAQ

Solo lectura

Returns the FAQ and settings of the automatic reply.

Sin campos de entrada.

Llama a: POST /v1/app/get_auto_reply_faq

update_auto_reply_faq · Change auto-reply FAQ

Cambia datos

Changes the FAQ and settings of the automatic reply.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/update_auto_reply_faq

Account and settings

get_stats · Get account statistics

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/stats

get_business_profile · Get business profile

Solo lectura

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

Sin campos de entrada.

Llama a: GET /v1/settings/profile

get_overview · Get account overview

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/tools/get_overview

update_brand · Change brand

Cambia datos

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

CampoTipoObligatorioDescripción
colorstringno
tonalitystringno

Llama a: POST /v1/tools/update_brand

set_whatsapp_profile_photo · Set WhatsApp profile photo

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectno{ media_id }

Llama a: POST /v1/app/set_whatsapp_profile_photo

list_widgets · List website widgets

Solo lectura

Lists the website widgets (popup and chat button).

Sin campos de entrada.

Llama a: POST /v1/app/list_widgets

get_widget_snippet · Get widget embed code

Solo lectura

Returns the code to paste into the website.

CampoTipoObligatorioDescripción
widget_idstringsíID (widget id).
min length 1 · max length 200

Llama a: POST /v1/app/get_widget_snippet

update_widget · Change a widget

Cambia datos

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

CampoTipoObligatorioDescripción
widget_idstringsíID (widget id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/update_widget

rotate_widget_token · Renew widget token

Envía, somete o borra

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

CampoTipoObligatorioDescripción
widget_idstringsíID (widget id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/rotate_widget_token

get_whatsapp_qr · Get WhatsApp QR code

Solo lectura

Returns the QR code for the WhatsApp number.

Sin campos de entrada.

Llama a: POST /v1/app/get_whatsapp_qr

get_notifications · Get notification settings

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_notifications

update_notifications · Change notification settings

Cambia datos

Switches notification emails on or off.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/update_notifications

invite_team_member · Invite a team member

Cambia datos

Invites a person to the team by email.

CampoTipoObligatorioDescripción
bodyobjectno{ email, role } - same fields as the app.

Llama a: POST /v1/app/invite_team_member

change_team_role · Change a team role

Cambia datos

Changes the role of a team member.

CampoTipoObligatorioDescripción
member_idstringsíID (member id).
min length 1 · max length 200
bodyobjectno{ role }

Llama a: POST /v1/app/change_team_role

remove_team_member · Remove a team member

Envía, somete o borra

Removes a person from the team.

CampoTipoObligatorioDescripción
member_idstringsíID (member id).
min length 1 · max length 200

Llama a: POST /v1/app/remove_team_member

get_billing · Get plan and subscription

Solo lectura

Returns the current plan and subscription state.

Sin campos de entrada.

Llama a: POST /v1/app/get_billing

list_invoices · List invoices

Solo lectura

Lists the invoices of the account.

Sin campos de entrada.

Llama a: POST /v1/app/list_invoices

get_credits · Get credits

Solo lectura

Returns the credit balance.

Sin campos de entrada.

Llama a: POST /v1/app/get_credits

get_credit_history · Get credit history

Solo lectura

Returns the history of credits used and added.

Sin campos de entrada.

Llama a: POST /v1/app/get_credit_history

list_rewards · List rewards

Solo lectura

Lists the bonus tasks and their state.

Sin campos de entrada.

Llama a: POST /v1/app/list_rewards

claim_reward · Claim a reward

Cambia datos

Claims a finished bonus task.

CampoTipoObligatorioDescripción
reward_idstringsíID (reward id).
min length 1 · max length 200
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/claim_reward

get_referral · Get referral program

Solo lectura

Returns the referral link and its results.

Sin campos de entrada.

Llama a: POST /v1/app/get_referral

list_domains · List domains

Solo lectura

Lists the domains and subdomain of the landing page.

Sin campos de entrada.

Llama a: POST /v1/app/list_domains

check_subdomain · Check a subdomain

Solo lectura

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

CampoTipoObligatorioDescripción
namestringnoOptional filter 'name'.

Llama a: POST /v1/app/check_subdomain

suggest_subdomain · Suggest subdomains

Solo lectura

Suggests free subdomains for the business.

Sin campos de entrada.

Llama a: POST /v1/app/suggest_subdomain

set_subdomain · Set the subdomain

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectno{ name }

Llama a: POST /v1/app/set_subdomain

connect_own_domain · Connect an own domain

Cambia datos

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

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

Llama a: POST /v1/app/connect_own_domain

verify_domain · Verify a domain

Cambia datos

Checks the DNS entries of a connected domain.

CampoTipoObligatorioDescripción
bodyobjectnoFields to send, same as in the app.

Llama a: POST /v1/app/verify_domain

set_domain_auto_renew · Switch domain auto-renew

Cambia datos

Switches the automatic renewal of a domain on or off.

CampoTipoObligatorioDescripción
domain_idstringsíID (domain id).
min length 1 · max length 200
bodyobjectno{ auto_renew: true|false }

Llama a: POST /v1/app/set_domain_auto_renew

delete_domain · Remove a domain

Envía, somete o borra

Removes a connected domain from the account.

CampoTipoObligatorioDescripción
domain_idstringsíID (domain id).
min length 1 · max length 200

Llama a: POST /v1/app/delete_domain

list_connected_ai_apps · List connected AI apps

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/list_connected_ai_apps

list_tutorials · List tutorials

Solo lectura

Lists the tutorial videos.

Sin campos de entrada.

Llama a: POST /v1/app/list_tutorials

send_feedback · Send feedback

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectnoSame fields as the app, e.g. { type, message }.

Llama a: POST /v1/app/send_feedback

get_onboarding_status · Get setup status

Solo lectura

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

Sin campos de entrada.

Llama a: POST /v1/app/get_onboarding_status

set_areas · Choose areas

Cambia datos

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

CampoTipoObligatorioDescripción
bodyobjectno{ areas: [...] } - same fields as the app.

Llama a: POST /v1/app/set_areas

¿Preguntas?

Escríbenos a support@smartchat.marketing