Listar campanhas de email no Brevo, por uma API

Lista as campanhas de email, da mais recente à mais antiga por padrão. A resposta traz campaigns e count; pagine com limit e offset. As estatísticas só vêm quando statistics é enviado.

Identificador
brevo_list_email_campaigns

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "classic"
  }
}

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
typestringNãoOnly campaigns of this type.Valores: classic, trigger
statusstringNãoOnly campaigns in this status.Valores: suspended, archive, sent, queued, draft, inProcess, inReview, cancelling, cancelled
statisticsstringNãoStatistics to include. They cover only the last 6 months; for older campaigns use Get email campaign.Valores: globalStats, linksStats, statsByDomain
startDatestringNãoOnly campaigns sent from this date-time. Requires endDate, works only without status or with status sent, and the range is up to 2 years.
endDatestringNãoOnly campaigns sent up to this date-time. Requires startDate.
excludeHtmlContentbooleanNãotrue leaves the HTML of each campaign out of the response.
sortstringNãoOrder of creation. The default is desc.Valores: asc, desc
limitintegerNãoCampaigns per page, up to 100. The default is 50.
offsetintegerNãoIndex of the first campaign of the page. The default is 0.

Conexões possíveis

O seu cliente conecta a conta do Brevo 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/brevo_list_email_campaigns. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

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