Criar rascunho de campanha no Mailjet, por uma API
Cria um rascunho de campanha e o retorna com seu ID. Para enviar, precisa de Sender, SenderEmail e ContactsListID, mais conteúdo: vincule um template com TemplateID ou escreva o conteúdo no editor do Mailjet.
- Identificador
- mailjet_create_campaign_draft
A chamada
POST https://connect.reportei.com/api/tools/mailjet_create_campaign_draft/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"Locale": "<Locale>",
"Subject": "<Subject>"
}
}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 |
|---|---|---|---|
| Locale | string | Sim | Language and country of the campaign, for example en_US or pt_BR. |
| Subject | string | Sim | Subject line of the email. |
| Title | string | Não | Internal title of the campaign, not shown to the recipients. |
| ContactsListID | integer | Não | ID of the list that receives the campaign, from List contact lists. |
| Sender | string | Não | ID of the sender, from List senders, as text. |
| SenderEmail | string | Não | Email address of an Active sender, from List senders. |
| SenderName | string | Não | Sender name shown to the recipients. |
| ReplyEmail | string | Não | Address that receives the replies. |
| TemplateID | integer | Não | ID of the template whose content the campaign uses, from List templates. |
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_create_campaign_draft. 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.
- Gerenciar contato da listaPOSTAdiciona 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.
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
