Crear lead en Instantly, con una API

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

Identificador
instantly_create_lead

La llamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "campaign": "<campaign>"
  }
}

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
campaignstringNoCampaign that gets the lead, by the id from List campaigns. Send it or list_id.
list_idstringNoLead list that gets the lead, by the id from List lead lists. Send it or campaign.
emailstringNoEmail of the lead, where the campaign sends.
first_namestringNoFirst name of the lead.
last_namestringNoLast name of the lead.
company_namestringNoCompany of the lead.
job_titlestringNoJob title of the lead.
phonestringNoPhone of the lead.
websitestringNoWebsite of the lead.
personalizationstringNoPersonalized line the email copy can use for this lead.
custom_variablesobjectNoExtra variables of the lead, as text, number or boolean values by name, like {"industry": "Retail"}. The campaign starts accepting the same variable names for its other leads.
skip_if_in_workspacebooleanNoWhen true, skips the lead if its email is already anywhere in the workspace.
skip_if_in_campaignbooleanNoWhen true, skips the lead if it is already in a campaign.
skip_if_in_listbooleanNoWhen true, skips the lead if it is already in a lead list.

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