Criar contato no GetResponse, por uma API
Adiciona 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.
- Identificador
- getresponse_create_contact
A chamada
POST https://connect.reportei.com/api/tools/getresponse_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>",
"campaign": {}
}
}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 |
|---|---|---|---|
| string | Sim | Email address of the contact. | |
| campaign | object | Sim | The campaign (contact list) of the contact, with campaignId from List campaigns. An email that is in another list becomes a separate contact in this one. |
| name | string | Não | Name of the contact. |
| dayOfCycle | string | Não | Day of the autoresponder cycle the contact starts on, as text, such as 0. Without it, the contact stays out of the cycle. |
| scoring | number | Não | Score of the contact. |
| ipAddress | string | Não | IPv4 or IPv6 address the person subscribed from. |
| openTrackingConsent | boolean | Não | true when the person agreed to have email opens tracked, false otherwise. |
Conexões possíveis
O seu cliente conecta a conta do GetResponse uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
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.
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/getresponse_create_contact. Ele vira a definição de tool do seu agente sem conversão.
Outras 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.
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
