Iniciar automatización

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

Inicia enseguida, para un contacto, una automatización activada que empieza con el trigger Llamada desde otro sistema. Hace lo mismo que su dirección secreta, pero basta con el ID de la automatización. Si el contacto todavía no existe, se crea.

Los pasos se ejecutan de verdad: un paso «Enviar plantilla» manda el mensaje de WhatsApp al contacto. Para una prueba usa una automatización con pasos inofensivos, por ejemplo «Añadir etiqueta».

El contacto: contact_id de un contacto de tu cuenta, o bien phone y/o email (con name, o first_name y last_name, para un contacto nuevo). Si no indicas ninguno de los tres, el contacto se lee de data como hace la dirección de la automatización: los campos elegidos en el editor o los nombres habituales (phone, email, name…).

Los campos de data se usan en los pasos como hook:nombre; las claves anidadas se convierten en hook:order.id. Como máximo 50 campos, 500 caracteres cada uno.

Respuestas: 200 con ran, run_id, run_status (done, waiting, failed…), reason, contact_id y contact_created; con ran: false la automatización no se ha iniciado porque sus condiciones («Si…») no se cumplen para este contacto — 200 con status: duplicate si la misma idempotency_key ya se usó en las últimas 24 horas — 404 si la automatización o el contacto no son de tu cuenta — 409 si la automatización está desactivada — 413 si el cuerpo supera 64 KB — 422 si un dato no es válido.

Errores comunes: 401 si falta la clave API o es incorrecta — 403 si el plan ha caducado o no incluye el acceso API, o si la app conectada (Zapier, Make) solo tiene permiso de lectura — 429 si haces demasiadas solicitudes en poco tiempo, o si la automatización ya recibió 120 inicios en el último minuto (cuentan también los de su dirección): vuelve a intentarlo tras los segundos indicados en la cabecera Retry-After.

Parámetros

9 · 2 obligatorios

apikey obligatorio

Tu API Key (también sirve la cabecera X-API-Key).

id obligatorio

ID de la automatización (entero, en la ruta). Usa GET /api/automations para encontrarlo.

contact_id opcional

ID de un contacto de tu cuenta.

phone opcional

Teléfono en formato internacional, por ejemplo +393331234567. Se usa si falta contact_id.

email opcional

Email del contacto. Se usa si falta contact_id.

name opcional

Nombre para un contacto nuevo (o bien first_name y last_name).

data opcional

Objeto con los campos que los pasos leen como hook:nombre, por ejemplo {"order_id": "1234"}.

token opcional

Solo para una automatización válida para todas las cuentas: el token de la cuenta del contacto. Para una automatización de una sola cuenta omítelo o pasa el suyo.

idempotency_key opcional

Una clave tuya, de hasta 200 caracteres: con la misma clave en 24 horas la automatización no vuelve a iniciarse y la respuesta es status: duplicate. La clave se comparte con la dirección secreta de la misma automatización: una clave ya recibida allí (cabecera Idempotency-Key) responde duplicate también aquí, y viceversa. También puedes usar la cabecera Idempotency-Key.

¿Necesitas ayuda con la integración? 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());