Listar cuentas de envío en Instantly, con una API

Lista las cuentas de envío (buzones) del workspace con email, estado y datos de warmup, 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_accounts

La llamada

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

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

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
searchstringNoText matched against the account email.
statusintegerNoOnly accounts in this status: 1 active, 2 paused, 3 paused for maintenance, -1 connection error, -2 soft bounce error, -3 sending error.Valores: 1, 2, 3, -1, -2, -3
filterstringNoOnly accounts that are paused, have errors, have no custom tracking domain (NO_CTD), or whose warmup is active, paused or failing (W_).Valores: ACC_FILTER_PAUSED, ACC_FILTER_ERROR, ACC_FILTER_NO_CTD, ACC_FILTER_W_ACTIVE, ACC_FILTER_W_PAUSED, ACC_FILTER_W_ERROR
limitintegerNoAccounts 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_accounts. 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.