Listar contas de envio no Instantly, por uma API

Lista as contas de envio (caixas de email) do workspace com email, status e dados de warmup, até limit por página. Para a próxima página, passe next_starting_after como starting_after, até que ele deixe de voltar.

Identificador
instantly_list_accounts

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
searchstringNãoText matched against the account email.
statusintegerNãoOnly 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
filterstringNãoOnly 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
limitintegerNãoAccounts per page, up to 100.
starting_afterstringNãoThe next_starting_after of the previous page.

Conexões possíveis

O seu cliente conecta a conta do Instantly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/instantly_list_accounts. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Instantly

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.