E-mail marketing
GetResponse no seu produto e nos seus agentes de IA, por uma API
O toolkit da GetResponse cobre contatos, campanhas (listas de contatos) e newsletters de uma conta GetResponse: buscar, criar e atualizar contatos, criar listas e criar, enviar e medir newsletters. Pelo Connect, seu produto ou agente de IA chama essas operações por um só endpoint, enquanto o Connect guarda a chave de API e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/getresponse_search_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"subscribersType": [],
"sectionLogicOperator": "or",
"section": []
}
}Como funciona
Do cliente conectado à primeira chamada no GetResponse.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do GetResponse. 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 GetResponse.
Adicionar contatos do seu produto
Quando um lead se cadastra no seu SaaS, crie o contato na campanha certa ou mova-o para outra lista quando a etapa dele mudar.
Newsletter criada por agente
Um agente de IA cria uma newsletter como rascunho, com o remetente e o fuso corretos, e seu produto a envia depois que uma pessoa aprova.
Relatório de desempenho
Liste as newsletters da conta e busque as estatísticas de cada uma, como aberturas, cliques e bounces, para um painel do cliente.
Tools
13 tools do GetResponse
- Buscar contatosPOSTBusca os contatos de uma ou mais campanhas (listas de contatos) por status de inscrição e, opcionalmente, por email ou nome. Contatos de double opt-in não confirmados aparecem só aqui. Pagine com page e perPage, até 1000; uma página menor que perPage é a última.
- Obter contatoGETRetorna um contato ativo com email, nome, campanha, dayOfCycle, tags e customFieldValues. Um contato removido responde 404.
- Criar contatoPOSTAdiciona um contato a uma campanha (lista de contatos). A GetResponse responde 202 sem corpo e processa em uma fila que pode levar alguns minutos, então encontre o contactId depois com Search contacts. Em uma lista de double opt-in, a pessoa recebe antes um email de confirmação. Um email já presente na lista responde 409.
- Atualizar contatoPOSTAtualiza um contato. Só os campos enviados mudam. Uma campanha diferente move o contato, com seu histórico e estatísticas, para essa lista.
- Listar campanhasGETLista as campanhas, que são as listas de contatos da GetResponse, com campaignId, nome, languageCode e isDefault. Pagine com page e perPage, até 1000; uma página menor que perPage é a última.
- Criar campanhaPOSTCria uma campanha, que é uma lista de contatos na GetResponse, e a retorna com seu campaignId. Uma conta tem até 1000 listas, e um nome já em uso responde 409.
- Listar newslettersGETLista as newsletters, rascunhos incluídos, com newsletterId, assunto, type, campanha, sendOn e sendMetrics, que traz delivered, openRate e clickRate. Pagine com page e perPage, até 1000; uma página menor que perPage é a última.
- Obter newsletterGETRetorna uma newsletter com seu conteúdo, fromField, campanha, sendSettings, sendOn e sendMetrics.
- Criar newsletterPOSTCria uma newsletter. Com type broadcast, o padrão, ela entra na fila de envio na hora, ou em sendSettings.sendOn; com type draft é apenas salva, para enviar depois com Send newsletter draft. A GetResponse aceita 256 dessas chamadas por dia.
- Enviar rascunho de newsletterPOSTEnvia um rascunho de newsletter aos destinatários de sendSettings, na hora ou em sendOn. O rascunho deixa de ser rascunho e entra na fila de envio.
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 GetResponse
Preciso implementar a API do GetResponse?
Não. O Connect já traz 13 tools do GetResponse 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 GetResponse?
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.
