Gerenciar contato da lista no Mailjet, por uma API
Adiciona um contato a uma lista por email, criando o contato quando o email é novo e definindo seu nome e propriedades, ou cancela a inscrição ou o remove da lista, conforme Action.
- Identificador
- mailjet_manage_list_contact
A chamada
POST https://connect.reportei.com/api/tools/mailjet_manage_list_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"list_ID": 1,
"Email": "<Email>",
"Action": "addforce"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| list_ID | integer | Sim | ID of the list, from List contact lists. |
| string | Sim | Email address of the contact. | |
| Action | string | Sim | addforce adds and subscribes the contact, even if it had unsubscribed from the list. addnoforce adds it but keeps an existing unsubscription. unsub unsubscribes it from the list and remove takes it out of the list.Valores: addforce, addnoforce, remove, unsub |
| Name | string | Não | Name of the contact. |
| Properties | object | Não | Values of contact properties keyed by the property name, from List contact properties, for example firstname. A name that is not a property of the account fails. |
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_manage_list_contact. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Mailjet
- Listar contatosGETLista 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.
- Obter contatoGETRetorna um contato, encontrado pelo ID ou pelo endereço de email, com nome, status de exclusão e datas de atividade. Use para obter o ID de um contato que você só conhece pelo email.
- Atualizar contatoPUTAltera o nome de um contato ou sua exclusão de emails de marketing. Só os campos enviados mudam. Um contato excluído continua recebendo emails transacionais.
- Listar listas de contatosGETLista as listas de contatos com ID, nome, número de inscritos e status de exclusão. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Criar lista de contatosPOSTCria uma lista de contatos vazia e a retorna com seu ID.
- Listar propriedades de contatoGETLista as propriedades de contato da conta com nome, tipo de dado e namespace. Os nomes são as chaves de Properties em Manage list contact. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Listar remetentesGETLista os endereços e domínios remetentes da conta com ID, email, nome e status. Só um remetente Active pode enviar uma campanha. A resposta traz Data, Count e Total; pagine com Limit e Offset.
- Listar templatesGETLista os templates de email com ID, nome, finalidades e modo de edição. O ID liga um template a um rascunho de campanha como seu conteúdo. A resposta traz Data, Count e Total; pagine com Limit e Offset.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
