Buscar contatos no GetResponse, por uma API
Busca 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.
- Identificador
- getresponse_search_contacts
A chamada
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": []
}
}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 |
|---|---|---|---|
| subscribersType | array | Sim | One subscription status: subscribed, unconfirmed (double opt-in not confirmed yet), undelivered, or removed for the unsubscribed. |
| sectionLogicOperator | string | Sim | How the sections combine: or matches any section, and matches all of them.Valores: or, and |
| section | array | Sim | Up to 8 groups of criteria. In each, campaignIdsList has the campaignId values from List campaigns; subscriberCycle with both values ignores the autoresponder cycle; subscriptionDate all_time ignores the date, and custom needs customDate. conditions is optional: up to 8 conditions on email or name, with operatorType string_operator, such as conditionType email, operator is and the address as value. |
| fields | string | Não | Fields to return, comma-separated, such as email,name,campaign. contactId always comes back. |
| perPage | integer | Não | Contacts per page, up to 1000. The default is 100. |
| page | integer | Não | Page number, starting at 1. |
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_search_contacts. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do GetResponse
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
