Atualizar broadcast no Kit, por uma API

Atualiza um broadcast em rascunho ou agendado. Envie subject e content em toda atualização, copiados de List broadcasts quando não mudam. Definir send_at agenda o envio, e null devolve o broadcast a rascunho.

Identificador
kit_update_broadcast

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": 1,
    "subject": "<subject>",
    "content": "<content>"
  }
}

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
idintegerSimID of the broadcast, from List broadcasts.
subjectstringSimSubject line of the email.
contentstringSimBody of the email as HTML. On a Classic template, the template adds its design around this body.
preview_textstringNãoPreview text shown after the subject in the inbox.
descriptionstringNãoInternal description of the broadcast, not shown to the subscribers.
send_atstringNãoWhen to send, in ISO 8601, for example 2026-11-02T13:00:00-03:00. Without a time zone it is UTC. It schedules the sending; null takes the broadcast back to draft.
email_addressstringNãoSending address of the account to send from.
email_template_idintegerNãoID of the email template, as the email_template id of a broadcast in List broadcasts. Starting point templates do not work.
publicbooleanNãotrue also publishes the broadcast on the web, in the newsletter feed of the Creator Profile and landing pages.
subscriber_filterarrayNãoWho receives the broadcast: one object with exactly one of all, any or none. Without it, every subscriber receives it.

Conexões possíveis

O seu cliente conecta a conta do Kit uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/kit, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/kit_update_broadcast. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Kit

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.