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âmetroTipoObrigatórioDescrição
emailstringSimEmail address of the contact.
campaignobjectSimThe 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.
namestringNãoName of the contact.
dayOfCyclestringNãoDay of the autoresponder cycle the contact starts on, as text, such as 0. Without it, the contact stays out of the cycle.
scoringnumberNãoScore of the contact.
ipAddressstringNãoIPv4 or IPv6 address the person subscribed from.
openTrackingConsentbooleanNãotrue 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

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.