Crear campaña en Instantly, con una API

Crea 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.

Identificador
instantly_create_campaign

La llamada

POST https://connect.reportei.com/api/tools/instantly_create_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>",
    "campaign_schedule": {}
  }
}

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ámetroTipoObligatorioDescripción
namestringSíName of the campaign.
campaign_scheduleobjectSíWhen the campaign sends.
sequencesarrayNoThe email copy, as a single sequence with its steps. Instantly only reads the first item.
email_listarrayNoSending accounts, by the email from List accounts.
daily_limitintegerNoMaximum emails the campaign sends per day.
daily_max_leadsintegerNoMaximum new leads contacted per day.
email_gapintegerNoMinutes between two emails of the campaign.
stop_on_replybooleanNoWhen true, a lead who replies gets no more steps.
stop_on_auto_replybooleanNoWhen true, an automatic reply, like out of office, also stops the lead.
stop_for_companybooleanNoWhen true, a reply stops every lead of the same company domain.
open_trackingbooleanNoWhether to track opens.
link_trackingbooleanNoWhether to track link clicks.
text_onlybooleanNoWhen true, every email goes as plain text.

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_create_campaign. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Instantly

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.