Avvia automazione

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

Avvia subito, per un contatto, un'automazione accesa che parte con il trigger Chiamata da un altro sistema. Fa la stessa cosa del suo indirizzo segreto, ma basta l'ID dell'automazione. Se il contatto non c'è ancora viene creato.

I passi partono davvero: un passo «Invia template» manda il messaggio WhatsApp al contatto. Per una prova usa un'automazione con passi innocui, per esempio «Aggiungi tag».

Il contatto: contact_id di un contatto del tuo account, oppure phone e/o email (con name, o first_name e last_name, per un contatto nuovo). Se non indichi nessuno dei tre, il contatto viene letto da data come fa l'indirizzo dell'automazione: i campi scelti nell'editor oppure i nomi abituali (phone, email, name…).

I campi di data si usano nei passi come hook:nome; le chiavi annidate diventano hook:order.id. Al massimo 50 campi, 500 caratteri ciascuno.

Risposte: 200 con ran, run_id, run_status (done, waiting, failed…), reason, contact_id e contact_created; con ran: false l'automazione non è partita perché le sue condizioni («Se…») non valgono per questo contatto — 200 con status: duplicate se la stessa idempotency_key è già stata usata nelle ultime 24 ore — 404 se l'automazione o il contatto non sono del tuo account — 409 se l'automazione è spenta — 413 se il corpo supera 64 KB — 422 se un dato non è valido.

Errori comuni: 401 se la chiave API manca o è sbagliata — 403 se il piano è scaduto o non include l'accesso API, oppure se l'app collegata (Zapier, Make) ha solo il permesso di lettura — 429 se fai troppe richieste in poco tempo, oppure se l'automazione ha già ricevuto 120 avvii nell'ultimo minuto (contano anche quelli del suo indirizzo): riprova dopo i secondi indicati nell'header Retry-After.

Parametri

9 · 2 obbligatori

apikey obbligatorio

La tua API Key (anche header X-API-Key).

id obbligatorio

ID dell'automazione (intero, nel path). Usa GET /api/automations per trovarlo.

contact_id opzionale

ID di un contatto del tuo account.

phone opzionale

Telefono in formato internazionale, per esempio +393331234567. Usato se manca contact_id.

email opzionale

Email del contatto. Usata se manca contact_id.

name opzionale

Nome per un contatto nuovo (oppure first_name e last_name).

data opzionale

Oggetto con i campi che i passi leggono come hook:nome, per esempio {"order_id": "1234"}.

token opzionale

Solo per un'automazione valida per tutti gli account: il token dell'account del contatto. Per un'automazione di un solo account ometti il parametro o passa il suo.

idempotency_key opzionale

Una chiave tua, fino a 200 caratteri: con la stessa chiave entro 24 ore l'automazione non riparte e la risposta è status: duplicate. La chiave è condivisa con l'indirizzo segreto della stessa automazione: una chiave già ricevuta lì (header Idempotency-Key) risponde duplicate anche qui, e viceversa. In alternativa all'header Idempotency-Key.

Serve aiuto con l'integrazione? 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());