Automation starten

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

Startet sofort für einen Kontakt eine eingeschaltete Automation mit dem Trigger Aufruf aus einem anderen System. Sie macht dasselbe wie ihre geheime Adresse, aber die ID der Automation genügt. Gibt es den Kontakt noch nicht, wird er angelegt.

Die Schritte laufen wirklich: Ein Schritt „Template senden“ schickt die WhatsApp-Nachricht an den Kontakt. Nimm für einen Test eine Automation mit harmlosen Schritten, zum Beispiel „Tag hinzufügen“.

Der Kontakt: contact_id eines Kontakts deines Kontos, oder phone und/oder email (mit name, oder first_name und last_name, für einen neuen Kontakt). Gibst du keins der drei an, wird der Kontakt aus data gelesen, wie es die Adresse der Automation tut: die im Editor gewählten Felder oder die üblichen Namen (phone, email, name…).

Die Felder von data werden in den Schritten als hook:name verwendet; verschachtelte Schlüssel werden zu hook:order.id. Höchstens 50 Felder mit je 500 Zeichen.

Antworten: 200 mit ran, run_id, run_status (done, waiting, failed…), reason, contact_id und contact_created; bei ran: false ist die Automation nicht gestartet, weil ihre Bedingungen („Wenn…“) für diesen Kontakt nicht erfüllt sind — 200 mit status: duplicate, wenn derselbe idempotency_key in den letzten 24 Stunden schon verwendet wurde — 404, wenn die Automation oder der Kontakt nicht zu deinem Konto gehört — 409, wenn die Automation ausgeschaltet ist — 413, wenn der Body größer als 64 KB ist — 422, wenn ein Wert ungültig ist.

Häufige Fehler: 401, wenn der API-Schlüssel fehlt oder falsch ist — 403, wenn der Tarif abgelaufen ist oder keinen API-Zugang enthält, oder wenn die verbundene App (Zapier, Make) nur Leserechte hat — 429, wenn du in kurzer Zeit zu viele Anfragen stellst oder die Automation in der letzten Minute schon 120 Starts erhalten hat (die Aufrufe ihrer Adresse zählen mit): Versuche es nach den Sekunden im Header Retry-After erneut.

Parameter

9 · 2 Pflichtfelder

apikey erforderlich

Ihr API Key (der Header X-API-Key funktioniert ebenfalls).

id erforderlich

ID der Automation (Ganzzahl, im Pfad). Mit GET /api/automations findest du sie.

contact_id optional

ID eines Kontakts deines Kontos.

phone optional

Telefonnummer im internationalen Format, zum Beispiel +393331234567. Wird verwendet, wenn contact_id fehlt.

email optional

E-Mail des Kontakts. Wird verwendet, wenn contact_id fehlt.

name optional

Name für einen neuen Kontakt (oder first_name und last_name).

data optional

Objekt mit den Feldern, die die Schritte als hook:name lesen, zum Beispiel {"order_id": "1234"}.

token optional

Nur für eine Automation, die für alle Konten gilt: der Token des Kontos des Kontakts. Bei einer Automation eines einzigen Kontos lass ihn weg oder gib dessen Token an.

idempotency_key optional

Ein eigener Schlüssel, bis zu 200 Zeichen: Mit demselben Schlüssel startet die Automation innerhalb von 24 Stunden nicht erneut und die Antwort ist status: duplicate. Der Schlüssel wird mit der geheimen Adresse derselben Automation geteilt: Ein dort schon erhaltener Schlüssel (Header Idempotency-Key) antwortet auch hier mit duplicate, und umgekehrt. Alternativ der Header Idempotency-Key.

Brauchen Sie Hilfe bei der Integration? 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());