Listar contatos no Mailjet, por uma API

Lista os contatos da conta com email, nome, status de exclusão e datas de atividade, opcionalmente só os de uma lista. A resposta traz Data, Count e Total; pagine com Limit e Offset.

Identificador
mailjet_list_contacts

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "ContactsList": 1
  }
}

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
ContactsListintegerNãoOnly the contacts of this list, by the ID from List contact lists.
CampaignintegerNãoOnly the contacts targeted by this campaign, by the CampaignID that List campaign drafts returns for a sent draft.
IsExcludedFromCampaignsbooleanNãotrue returns only the contacts excluded from marketing emails, false leaves them out.
LimitintegerNãoContacts per page, up to 1000. The default is 10.
OffsetintegerNãoIndex of the first contact of the page. The default is 0.
SortstringNãoProperty and order separated by a space, for example ID DESC for the newest first. Not every property can sort.

Conexões possíveis

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

Usuário e senha

O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia 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/mailjet_list_contacts. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Mailjet

Ver as 15 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.