Démarrer une automatisation

POST https://app.sendapp.ai/api/automations/{id}/start

Démarre tout de suite, pour un contact, une automatisation activée qui démarre avec le trigger Appel d'un autre système. Elle fait la même chose que son adresse secrète, mais l'ID de l'automatisation suffit. Si le contact n'existe pas encore, il est créé.

Les étapes s'exécutent vraiment : une étape « Envoyer un template » envoie le message WhatsApp au contact. Pour un essai, utilise une automatisation aux étapes inoffensives, par exemple « Ajouter un tag ».

Le contact : contact_id d'un contact de ton compte, ou bien phone et/ou email (avec name, ou first_name et last_name, pour un nouveau contact). Si tu n'indiques aucun des trois, le contact est lu dans data comme le fait l'adresse de l'automatisation : les champs choisis dans l'éditeur ou les noms habituels (phone, email, name…).

Les champs de data s'utilisent dans les étapes comme hook:nom ; les clés imbriquées deviennent hook:order.id. 50 champs au maximum, 500 caractères chacun.

Réponses : 200 avec ran, run_id, run_status (done, waiting, failed…), reason, contact_id et contact_created ; avec ran: false l'automatisation n'a pas démarré parce que ses conditions (« Si… ») ne sont pas remplies pour ce contact — 200 avec status: duplicate si la même idempotency_key a déjà été utilisée dans les dernières 24 heures — 404 si l'automatisation ou le contact n'appartient pas à ton compte — 409 si l'automatisation est désactivée — 413 si le corps dépasse 64 Ko — 422 si une donnée n'est pas valide.

Erreurs courantes : 401 si la clé API manque ou est erronée — 403 si le forfait a expiré ou n'inclut pas l'accès API, ou si l'app connectée (Zapier, Make) n'a que l'autorisation de lecture — 429 si tu fais trop de requêtes en peu de temps, ou si l'automatisation a déjà reçu 120 démarrages dans la dernière minute (ceux de son adresse comptent aussi) : réessaie après les secondes indiquées dans l'en-tête Retry-After.

Paramètres

9 · 2 obligatoires

apikey obligatoire

Votre API Key (l'en-tête X-API-Key fonctionne aussi).

id obligatoire

ID de l'automatisation (entier, dans le chemin). Utilise GET /api/automations pour le trouver.

contact_id facultatif

ID d'un contact de ton compte.

phone facultatif

Téléphone au format international, par exemple +393331234567. Utilisé si contact_id manque.

email facultatif

Email du contact. Utilisé si contact_id manque.

name facultatif

Nom pour un nouveau contact (ou bien first_name et last_name).

data facultatif

Objet avec les champs que les étapes lisent comme hook:nom, par exemple {"order_id": "1234"}.

token facultatif

Seulement pour une automatisation valable pour tous les comptes : le token du compte du contact. Pour une automatisation d'un seul compte, omets-le ou passe le sien.

idempotency_key facultatif

Une clé à toi, jusqu'à 200 caractères : avec la même clé dans les 24 heures, l'automatisation ne redémarre pas et la réponse est status: duplicate. La clé est partagée avec l'adresse secrète de la même automatisation : une clé déjà reçue là-bas (en-tête Idempotency-Key) répond duplicate ici aussi, et inversement. Tu peux aussi utiliser l'en-tête Idempotency-Key.

Besoin d'aide pour l'intégration ? info@sendapp.live

curl -X POST 'https://app.sendapp.ai/api/automations/318/start' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "phone": "+393331234567", "name": "Anna Rossi", "data": { "order": { "id": "A-77", "total": "49.90" } }, "idempotency_key": "order-A-77" }'

<?php $ch = curl_init('https://app.sendapp.ai/api/automations/318/start'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'phone' => '+393331234567', 'name' => 'Anna Rossi', 'data' => ['order' => ['id' => 'A-77', 'total' => '49.90']], 'idempotency_key' => 'order-A-77', ]), ]); echo curl_exec($ch); curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/automations/318/start', { method: 'POST', headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ phone: '+393331234567', name: 'Anna Rossi', data: { order: { id: 'A-77', total: '49.90' } }, idempotency_key: 'order-A-77' }) }); console.log(await res.json());