Endpoint outils IA

POST /v1/tools/{name} exécute directement un outil de SmartChat AI, sans modèle IA entre les deux. Les textes envoyés sont repris mot pour mot. GET /v1/tools liste tous les outils avec leur schéma et si ta clé peut les utiliser.

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

curl -X POST https://api.smartchat.marketing/v1/tools/update_landing \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"arguments": {"headline": "Fresh bread every morning"}}'

{"tool": "update_landing", "ok": true, "result": { ... }}

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.

59 tools

POST/v1/tools/get_overview · Get account overview

Lecture seuleDroit: stats:read

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

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/list_media · List media

Lecture seuleDroit: media:read

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

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/save_to_library · Save to media library

Modifie des donnéesDroit: media:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
media_idstringoui

POST/v1/tools/update_landing · Change landing page texts

Modifie des donnéesDroit: landing:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

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.

POST/v1/tools/swap_landing_image · Change landing page image

Modifie des donnéesDroit: landing:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
positionanyoui
querystringnon

POST/v1/tools/get_landing_blocks · Get landing page blocks

Lecture seuleDroit: landing:read

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
positionanynon

POST/v1/tools/add_landing_block · Add landing page block

Modifie des donnéesDroit: landing:writeUtilise des crédits comme un message à SmartChat AI

Adds a block (section) to the landing page.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
typestringoui
dataobjectnon
variantstringnon
tonstringnon
positionanynon
stilarray of objectnon

POST/v1/tools/remove_landing_block · Remove landing page block

Envoie, soumet ou supprimeDroit: landing:write

Removes a block from the landing page.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
positionanyoui

POST/v1/tools/move_landing_block · Move landing page block

Modifie des donnéesDroit: landing:write

Moves a block to another position on the landing page.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
fromanyoui
toanyoui

POST/v1/tools/set_landing_style · Change landing page style

Modifie des donnéesDroit: landing:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
radiusanynon
shadowanynon
spacinganynon
widthanynon
buttonanynon
imageanynon
stilarray of objectnon

POST/v1/tools/update_landing_block · Change landing page block

Modifie des donnéesDroit: landing:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
positionanyoui
karteanynon
dataobjectnon
variantstringnon
tonstringnon
stilarray of objectnon

POST/v1/tools/publish_landing · Publish landing page

Envoie, soumet ou supprimeDroit: landing:write

Publishes the landing page so the changes are live.

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/create_followup_sequence · Create follow-up sequence

Modifie des donnéesDroit: followups:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
namestringoui
stepsarray of objectoui
activatebooleannon
verbatimarray of stringnon

POST/v1/tools/update_followup_step · Change follow-up step

Modifie des donnéesDroit: followups:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
step_idstringoui
contentstringnon
subjectstringnon
delay_hoursnumbernon
verbatimarray of stringnon

POST/v1/tools/add_followup_step · Add follow-up step

Modifie des donnéesDroit: followups:writeUtilise des crédits comme un message à SmartChat AI

Adds a message to a follow-up sequence.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
sequence_idstringoui
channelstringnon
delay_hoursnumbernon
contentstringoui
buttonanynon
mediaobjectnon
verbatimarray of stringnon

POST/v1/tools/delete_followup_step · Delete follow-up step

Envoie, soumet ou supprimeDroit: followups:write

Deletes one message from a follow-up sequence.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
step_idstringoui

POST/v1/tools/rename_followup_sequence · Rename follow-up sequence

Modifie des donnéesDroit: followups:write

Renames a follow-up sequence.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
sequence_idstringoui
namestringoui

POST/v1/tools/set_followup_status · Pause or start follow-ups

Modifie des donnéesDroit: followups:write

Pauses or starts a follow-up sequence.

Données (body): {"arguments": { ... }}

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

POST/v1/tools/create_newsletter · Create newsletter

Modifie des donnéesDroit: newsletters:writeUtilise 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.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
subjectstringoui
contentstringoui
channelstringnon
mediaobjectnon
ctaobjectnon
segmentobjectnon

POST/v1/tools/update_newsletter · Change newsletter

Modifie des donnéesDroit: newsletters:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui
subjectstringnon
contentstringnon
mediaanynon
ctaanynon
segmentanynon

POST/v1/tools/send_newsletter · Send newsletter now

Envoie, soumet ou supprimeDroit: newsletters:schedule

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.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui
confirm_tokenstringnon

POST/v1/tools/test_newsletter · Send test newsletter

Envoie, soumet ou supprimeDroit: newsletters:schedule

Sends a newsletter to the test phone number only.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui
tostringnon

POST/v1/tools/schedule_newsletter · Schedule newsletter

Envoie, soumet ou supprimeDroit: newsletters:schedule

Schedules a newsletter. First call returns a preview and confirm_token; the second call with confirm_token schedules.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui
scheduled_atstringoui
confirm_tokenstringnon

POST/v1/tools/cancel_newsletter · Cancel newsletter

Envoie, soumet ou supprimeDroit: newsletters:schedule

Cancels a scheduled newsletter.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui

POST/v1/tools/get_newsletter · Get newsletter

Lecture seuleDroit: newsletters:read

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
newsletter_idstringoui

POST/v1/tools/create_template · Create template

Modifie des donnéesDroit: templates:writeUtilise des crédits comme un message à SmartChat AI

Creates a WhatsApp template as draft. Texts are used word for word.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
namestringoui
channelstringnon
contentstringoui
subjectstringnon
buttonsarray of anynon
mediaobjectnon
verbatimarray of stringnon

POST/v1/tools/update_template · Change template

Modifie des donnéesDroit: templates:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
template_idstringoui
namestringnon
contentstringnon
subjectstringnon
buttonsanynon
mediaanynon
verbatimarray of stringnon

POST/v1/tools/delete_template · Delete template

Envoie, soumet ou supprimeDroit: templates:delete

Deletes a template.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
template_idstringoui

POST/v1/tools/submit_all_templates · Submit all templates

Envoie, soumet ou supprimeDroit: templates:submit

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
confirm_tokenstringnon

POST/v1/tools/submit_template · Submit template to WhatsApp

Envoie, soumet ou supprimeDroit: templates:submit

Submits a template to WhatsApp for approval. First call returns a check and confirm_token; the second call with confirm_token submits.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
template_idstringoui
confirm_tokenstringnon

POST/v1/tools/get_stats · Get statistics

Lecture seuleDroit: stats:read

Returns the key figures of the account.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
rangestring ("7d", "30d", "90d")non

POST/v1/tools/list_contacts · List contacts

Lecture seuleDroit: contacts:read

Lists contacts with their opt-in state and tags.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
typestringnon
searchstringnon

POST/v1/tools/add_contact · Add contact

Modifie des donnéesDroit: contacts:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
namestringnon
emailstringnon
phonestringnon

POST/v1/tools/resend_optin_confirmation · Resend confirmation

Envoie, soumet ou supprimeDroit: messages:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
contact_idstringoui
confirm_tokenstringnon

POST/v1/tools/tag_contacts · Tag contacts

Modifie des donnéesDroit: contacts:write

Adds tags to one or more contacts.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
tagstringoui
contact_idsarray of anyoui
grundstringnon

POST/v1/tools/untag_contacts · Remove tags

Modifie des donnéesDroit: contacts:write

Removes tags from one or more contacts.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
tagstringoui
contact_idsarray of anyoui

POST/v1/tools/export_contacts · Export contacts

Lecture seuleDroit: contacts:read

Exports the contacts as CSV text.

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/update_brand · Change brand

Modifie des donnéesDroit: settings:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
colorstringnon
tonalitystringnon

POST/v1/tools/set_landing_tracking · Set tracking pixel

Modifie des donnéesDroit: landing:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
meta_pixel_idstringnon
meta_capi_tokenstringnon
google_idstringnon
gtm_idstringnon
tiktok_idstringnon
tiktok_events_tokenstringnon

POST/v1/tools/find_text · Find text

Lecture seuleDroit: landing:read

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
textstringoui

POST/v1/tools/update_website_popup · Change website popup

Modifie des donnéesDroit: landing:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

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

POST/v1/tools/scan_website · Scan website

Modifie des donnéesDroit: settings:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
urlstringoui

POST/v1/tools/set_constraint · Set a content rule

Modifie des donnéesDroit: settings:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
valuestringoui
kindstringnon

POST/v1/tools/search_knowledge · Search business knowledge

Lecture seuleDroit: settings:read

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
querystringoui
limitnumbernon

POST/v1/tools/refresh_brain · Rebuild business knowledge

Modifie des donnéesDroit: settings:writeUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
forcebooleannon

POST/v1/tools/get_growth_plan · Get growth plan

Lecture seuleDroit: settings:readUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/get_next_step · Get next step

Lecture seuleDroit: settings:read

Returns the most useful next step for the account.

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/refresh_reviews · Reload reviews

Modifie des donnéesDroit: landing:writeUtilise des crédits comme un message à SmartChat AI

Loads the latest Google reviews for the landing page.

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/web_research · Research on the web

Lecture seuleDroit: settings:readUtilise des crédits comme un message à SmartChat AI

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
querystringoui
languagestringnon

POST/v1/tools/list_automations · List automations

Lecture seuleDroit: automations:read

Lists the automations with state and trigger.

Données (body): {"arguments": { ... }}

Aucun champ d'entrée.

POST/v1/tools/create_automation · Create automation

Modifie des donnéesDroit: automations:writeUtilise des crédits comme un message à SmartChat AI

Creates an automation (trigger and actions).

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
namestringoui
trigger_typestringoui
trigger_configobjectnon
actionsarray of objectoui
contact_fieldsarray of stringnon
activatebooleannon

POST/v1/tools/update_automation · Change automation

Modifie des donnéesDroit: automations:writeUtilise des crédits comme un message à SmartChat AI

Changes an automation, or pauses and activates it.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui
namestringnon
statusstringnon
actionsanynon
trigger_configanynon

POST/v1/tools/test_automation · Test automation

Modifie des donnéesDroit: automations:write

Runs an automation once with test data.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui
sample_payloadobjectnon

POST/v1/tools/get_automation_setup · Get automation setup

Lecture seuleDroit: automations:read

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui

POST/v1/tools/connect_calendar · Connect calendar

Modifie des donnéesDroit: automations:write

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui
calendar_urlstringnon
providerstringnon
lead_minutesnumbernon

POST/v1/tools/get_automation_runs · Get automation runs

Lecture seuleDroit: automations:read

Returns the latest runs of an automation.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui
limitnumbernon

POST/v1/tools/delete_automation · Delete automation

Envoie, soumet ou supprimeDroit: automations:delete

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

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
automation_idstringoui
confirm_tokenstringnon

POST/v1/tools/create_free_automation · Create custom automation

Modifie des donnéesDroit: automations:writeUtilise 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.

Données (body): {"arguments": { ... }}

ChampTypeObligatoireDescription
namestringoui
regelobjectoui
actionsarray of objectoui
contact_fieldsarray of stringnon
activatebooleannon
confirmedbooleannon

Des questions ?

Écris-nous à support@smartchat.marketing