Listar leads en Instantly, con una API

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

Identificador
instantly_list_leads

La llamada

POST https://connect.reportei.com/api/tools/instantly_list_leads/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
campaignstringNoOnly leads of this campaign, by the id from List campaigns.
list_idstringNoOnly leads of this lead list, by the id from List lead lists.
searchstringNoWhole words, or the start of a value, matched against email, names, company and job title. Leads created a few seconds ago may not show yet.
filterstringNoOnly leads in this state, like FILTER_VAL_REPLIED for leads that replied or FILTER_LEAD_INTERESTED for leads marked as interested.Valores: FILTER_VAL_CONTACTED, FILTER_VAL_NOT_CONTACTED, FILTER_VAL_COMPLETED, FILTER_VAL_UNSUBSCRIBED, FILTER_VAL_ACTIVE, FILTER_LEAD_INTERESTED, FILTER_LEAD_NOT_INTERESTED, FILTER_LEAD_MEETING_BOOKED, FILTER_LEAD_MEETING_COMPLETED, FILTER_LEAD_CLOSED, FILTER_LEAD_OUT_OF_OFFICE, FILTER_LEAD_WRONG_PERSON, FILTER_LEAD_LOST, FILTER_LEAD_NO_SHOW, FILTER_VAL_BOUNCED, FILTER_VAL_SKIPPED, FILTER_VAL_REPLIED, FILTER_VAL_OPENED_NO_REPLY, FILTER_VAL_COMPLETED_NO_REPLY, FILTER_VAL_NO_OPENS, FILTER_VAL_LINK_CLICKED
contactsarrayNoOnly leads with these emails.
idsarrayNoOnly these leads, by the id from a previous call of List leads.
in_campaignbooleanNoTrue for leads that are in a campaign, false for leads outside any campaign.
in_listbooleanNoTrue for leads that are in a lead list, false for leads outside any list.
limitintegerNoLeads per page, up to 100.
starting_afterstringNoThe next_starting_after of the previous page.

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