Activar campaña en Instantly, con una API
Inicia una campaña en borrador o reanuda una pausada. Instantly pasa entonces a enviar los pasos a los leads de la campaña, desde las cuentas de email_list, dentro del horario.
- Identificador
- instantly_activate_campaign
La llamada
POST https://connect.reportei.com/api/tools/instantly_activate_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string | Sí | Id of the campaign, from List campaigns. |
Conexiones posibles
Tu cliente conecta su cuenta de Instantly una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/instantly_activate_campaign. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Instantly
- Listar campañasGETLista las campañas del workspace con id, nombre y estado, hasta limit por página. Para la página siguiente, pasa next_starting_after como starting_after, hasta que deje de volver.
- Obtener campañaGETDevuelve una campaña con estado, horario, sequences (los pasos de email y sus variantes), cuentas de envío en email_list y opciones de envío.
- Crear campañaPOSTCrea una campaña como borrador, con su horario, pasos de email y cuentas de envío. Agrega leads con Create lead y ponla en marcha con Activate campaign.
- Actualizar campañaPATCHCambia una campaña. Envía solo los campos a cambiar; sequences y campaign_schedule reemplazan por completo los actuales.
- Pausar campañaPOSTPausa una campaña, y no sale ningún email hasta que Activate campaign la reanude.
- Obtener analíticas de la campañaGETDevuelve, por campaña, leads, contactados, emails enviados, aperturas, respuestas, clics en enlaces, rebotes, bajas, leads completados y oportunidades, de una campaña o de todas.
- Listar leadsPOSTLista leads con email, nombres, empresa, estado y estado de interés, hasta limit por página. Para la página siguiente, pasa next_starting_after como starting_after, hasta que deje de volver.
- Crear leadPOSTAgrega un lead a una campaña o a una lista de leads. Un lead agregado a una campaña activa entra en la secuencia y recibe emails según el horario.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
