E-mail marketing
Omnisend no seu produto e nos seus agentes de IA, por uma API
O toolkit do Omnisend cobre contatos, tags, segmentos, templates de email, campanhas, eventos de cliente, relatórios e produtos: criar e atualizar contatos, aplicar tags, montar e enviar campanhas de email ou SMS, enviar eventos que disparam automações e ler métricas agregadas. O cliente conecta com uma API key do Omnisend, e seu produto ou agente de IA chama cada operação por um único endpoint do Connect.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/omnisend_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"identifiers": []
}
}Como funciona
Do cliente conectado à primeira chamada no Omnisend.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Omnisend. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Omnisend.
Compradores sincronizados no Omnisend
Crie ou atualize um contato quando um cliente se cadastra ou compra na sua loja, defina o status do canal e aplique tags para alimentar segmentos.
Automações disparadas pelo seu app
Envie um evento de cliente, como um pedido realizado ou um evento customizado, para iniciar as automações que escutam o nome desse evento.
Campanhas e relatórios por agente
Deixe um agente criar uma campanha em rascunho a partir de um template, enviar um email de teste, disparar a campanha e depois ler o relatório de envios, aberturas e cliques.
Tools
14 tools do Omnisend
- Listar contatosGETLista os contatos com id, email, phone, status, tags, segments e propriedades customizadas, do mais novo para o mais antigo por padrão. A resposta tem contacts e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Criar contatoPOSTCria um contato, ou atualiza o contato que já tem o mesmo identificador de email. Definir um canal como subscribed envia a mensagem de boas-vindas da marca, quando essa automação está ativa, a menos que sendWelcomeMessage seja false.
- Atualizar contatoPATCHAtualiza um contato. Só os campos enviados mudam, mas tags substitui a lista inteira de tags: para só adicionar tags, use Aplicar tags. Um status de canal em identifiers inscreve ou cancela a inscrição do contato.
- Aplicar tagsPOSTAdiciona tags a contatos, mantendo as tags que eles já têm. Escolha os contatos por contactIDs, emails, phones ou segmentID; as seleções se somam. Limitado a 60 chamadas por minuto.
- Listar segmentosGETLista os segmentos com segmentID, name e status. O segmentID direciona campanhas e filtra contatos. A resposta tem segments e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar templates de emailGETLista os templates de email com id e name, do mais novo para o mais antigo por padrão. O id é o corpo de uma campanha de email. A resposta tem templates e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after.
- Listar campanhasGETLista as campanhas com id, name, status, channel, content, audience e configurações de envio, da mais nova para a mais antiga por padrão. A resposta tem campaigns e paging; enquanto paging.hasMore for true, passe paging.cursors.after como after e mantenha os filtros.
- Criar campanhaPOSTCria uma campanha comum de email ou SMS como rascunho e a retorna com seu id. Uma campanha de email precisa de content.email.templateID, de Listar templates de email, e uma de SMS precisa de content.sms. Nada é enviado até Enviar campanha.
- Atualizar campanhaPATCHAtualiza uma campanha em status draft. Só os campos enviados mudam. O template de email continua o definido na criação. Para alterar uma campanha que não é mais rascunho, o app pede uma cópia.
- Enviar email de teste da campanhaPOSTEnvia por email uma prévia de uma campanha de email em rascunho para até 5 endereços, com o assunto, o remetente e o conteúdo salvos. A campanha em si não muda.
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.
Perguntas sobre o toolkit do Omnisend
Preciso implementar a API do Omnisend?
Não. O Connect já traz 14 tools do Omnisend descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Omnisend?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
