Criar newsletter no GetResponse, por uma API

Cria 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.

Identificador
getresponse_create_newsletter

A chamada

POST https://connect.reportei.com/api/tools/getresponse_create_newsletter/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "subject": "<subject>",
    "fromField": {},
    "campaign": {},
    "content": {},
    "sendSettings": {}
  }
}

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
typestringNãobroadcast sends it, draft only saves it. The default is broadcast.Valores: broadcast, draft
namestringNãoInternal name of the newsletter.
subjectstringSimSubject of the email.
fromFieldobjectSimSender, with fromFieldId from List from fields.
replyToobjectNãoReply-to address, with fromFieldId from List from fields.
campaignobjectSimCampaign (contact list) the newsletter belongs to, with campaignId from List campaigns.
contentobjectSimBody of the email: html, and optionally a plain text version in plain.
flagsarrayNãoclicktrack tracks the link clicks, google_analytics adds the Google Analytics tags to the links.
trackOpensstringNãoTracks the opens, as the text true or false. The default is true.Valores: true, false
sendSettingsobjectSimWho receives it and when. selectedCampaigns and excludedCampaigns take campaignId values from List campaigns, and selectedContacts takes contactId values from Search contacts; the criteria combine with AND. Without sendOn, it goes right away; sendOn takes date in local time, such as 2026-11-05T09:00:00, and timeZone with the timezoneId from List time zones. timeTravel true sends at that hour in the time zone of each recipient.

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_newsletter. 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.