Zinn® Campaigns API e MCP: guia do desenvolvedor

Tudo o que você pode fazer no Zinn® Campaigns pelo painel, você também pode fazer por meio da API, e a maior parte disso a partir de um assistente de IA conectado à sua conta via MCP. Este guia aborda o login, as permissões, um exemplo prático de ambas as formas, os limites, os erros e cada uma das 89 operações do Campaigns. A lista de operações abaixo é gerada a partir da nossa especificação de API, portanto, sempre corresponde ao que a API faz. Cada campo de cada operação está na referência da API em zinndigital.com/developers/api/zinn-campaigns.

Como entrar

• Chaves de API. Crie uma chave no painel em Configurações → Chaves de API e envie-a como Authorization: Bearer zdk_live_… (uma chave zdk_test_… funciona no modo sandbox). Conceda à chave apenas as permissões de Campaigns necessárias e nada mais.
• Assistentes de IA (MCP). Conecte o Claude, ChatGPT, Cursor ou qualquer cliente MCP a https://api.zinndigital.com/v1/mcp, seja iniciando sessão pelo aplicativo ou com um token de conexão (zmcp_live_…). Consulte Conectar o Claude, Cursor ou ChatGPT à sua conta. Na tela de consentimento, marque as permissões do Zinn® Campaigns.
• Permissões. O email_marketing.view lê campanhas, listas, contatos, formulários, remetentes, configurações de SMS e relatórios; o email_marketing.manage cria e altera esses itens. As campanhas que você envia pelo seu próprio serviço de e-mail usam campaigns.view e campaigns.manage.
• Revendedores. Passe org_id para atuar em uma das organizações de seus clientes. Omita-o quando sua chave ou conexão alcançar exatamente uma organização.

Exemplo: criar um rascunho de campanha com a API

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

A resposta é 201 com o rascunho. Teste-o com POST /v1/email-marketing/campaigns/{campaign_id}/test, valide-o com GET /v1/email-marketing/campaigns/{campaign_id}/lint e envie-o com POST /v1/email-marketing/campaigns/{campaign_id}/send.

Exemplo: o mesmo rascunho a partir de um assistente de IA

Peça ao seu assistente em palavras simples, por exemplo "faça um rascunho de e-mail do Zinn® Campaigns chamado Spring sale com o assunto 'Our spring sale starts today'". Nos bastidores, ele encontra a operação com api_operations_search, lê seus parâmetros com api_operation_get e a executa com api_operation_call:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

O que um assistente não fará. Qualquer ação que faça envios para seus destinatários ou gaste dinheiro ou limites — enviar uma campanha, enviar mensagens de SMS ou WhatsApp, escrever com créditos de IA, registrar-se para mensagens de texto nos US — é recusada a um assistente, garantindo que uma instrução mal compreendida nunca chegue aos seus clientes. O assistente prepara o rascunho; você clica em Enviar no painel ou chama a API diretamente. Informações confidenciais, como uma senha de SMTP, também nunca passam por um assistente: insira-as no painel.

Limites

• 1.200 solicitações por minuto para cada pessoa ou chave de API e 6.000 solicitações por minuto para cada organização. O mais restritivo dos dois se aplica.
• 600 solicitações por minuto para cada conexão MCP.
• Ao ultrapassar um limite, a resposta é 429 com um cabeçalho Retry-After: aguarde essa quantidade de segundos.
• A adição de membros à lista aceita no máximo 1.000 endereços por solicitação; as cotas de contatos e e-mails do seu plano se aplicam a tudo o que você fizer por meio da API.

Erros

Todo erro tem o mesmo formato:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

O code nunca muda para o mesmo problema, portanto teste-o em vez de message. Informe o request_id quando entrar em contato com o suporte. As respostas que você encontrará: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. Um 403 significa que a chave ou a conexão não possui uma permissão indicada na lista abaixo; um 404 também cobre algo em uma organização que você não pode ver; um 422 lista cada campo incorreto em details; após um 429, aguarde o número de segundos no cabeçalho Retry-After.

Webhooks

Os resultados de entrega chegam ao Zinn® Campaigns a partir do provedor que envia seu e-mail:

• Com o seu próprio provedor (por exemplo, Resend), armazene o segredo de assinatura de webhook dele na conexão de envio no painel (Campanhas → Envio). Você recebe uma webhook_url; aponte os eventos delivered, bounced e complained do provedor para ela. Uma rejeição ou uma denúncia de spam remove o endereço de envios futuros imediatamente.
• Com o envio Zinn®, não há nada para configurar.

Leia os resultados com as operações de relatório (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Todas as operações do Campaigns

Visão geral

• GET /v1/email-marketing — Visão geral do Zinn® Campaigns para uma organização. Operação getEmailMarketingOverview. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.

Campanhas de e-mail

• GET /v1/email-marketing/campaigns — Campanhas de e-mail, mais recentes primeiro, uma página keyset. Operação listEmailMarketingCampaigns. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/campaigns — Crie um rascunho de campanha de e-mail. Operação createEmailMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — Uma campanha de e-mail. Operação getEmailMarketingCampaign. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Edite um rascunho (ou uma campanha recusada, que retorna para rascunho). Operação updateEmailMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Verifique o texto de uma campanha quanto a problemas de entregabilidade antes do envio. Operação lintEmailMarketingCampaign. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Os números de uma campanha. Operação getEmailMarketingCampaignReport. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — Inicie o envio de uma campanha para a respectiva lista. Operação sendEmailMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: apenas API e painel: consome dinheiro ou cota, portanto uma pessoa deve acionar (envia para destinatários reais e consome a cota).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — Envie uma cópia de teste agora para um membro da organização. Operação testEmailMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, através do MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — Traduza uma campanha para todos os idiomas de contato ausentes ou desatualizados. Operação translateEmailMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, através do MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — Cada idioma de contato da lista de uma campanha e se a tradução está atualizada. Operação listEmailMarketingCampaignTranslations. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, através do MCP.

Escrevendo com IA

• POST /v1/email-marketing/ai/write — Escreva um rascunho de e-mail de campanha a partir de um breve resumo com o Zinn® AI. Operação writeEmailMarketingCampaignWithAi. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: apenas API e painel: gasta dinheiro ou franquia, portanto uma pessoa deve acioná-lo (a escrita por IA consome créditos de IA).

Kit de marca

• GET /v1/email-marketing/brand-kit — O kit de marca da organização (nome, logotipo, cores, fonte, tom de voz). Operação getEmailMarketingBrandKit. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• PUT /v1/email-marketing/brand-kit — Editar o kit de marca. Operação updateEmailMarketingBrandKit. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/brand-kit/read — Ler o kit de marca a partir do site da organização. Operação readEmailMarketingBrandKit. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.

Contatos e mensagens avulsas

• GET /v1/email-marketing/contacts — Os contatos da organização, uma página de keyset por vez. Operação listEmailMarketingContacts. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Envia um SMS para um contato, pago com o saldo de créditos da Zinn®. Operação sendEmailMarketingMessage. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: apenas API e painel: envolve custo financeiro ou de franquia, portanto uma pessoa deve acioná-lo (uma mensagem avulsa para um contato consome franquia).
• GET /v1/email-marketing/messages — Mensagens de SMS e WhatsApp enviadas pela organização, as mais recentes primeiro, uma página de keyset. Operação listEmailMarketingMessages. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.

Listas

• GET /v1/email-marketing/lists — Listas de e-mails da organização com contagens de inscritos / cancelados. Operação listEmailMarketingLists. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/lists — Crie uma lista de e-mails (ou retorne a existente com esse nome). Operação createEmailMarketingList. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/lists/{list_id}/members — Adicione contatos a uma lista por endereço de e-mail (no máximo 1.000 por solicitação). Operação addEmailMarketingListMembers. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.

Importações

• GET /v1/email-marketing/imports — Importações de contatos anteriores, as mais recentes primeiro, uma página keyset por vez. Operação listEmailMarketingImports. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/imports — Importe um lote de contatos com sua comprovação de consentimento. Operação createEmailMarketingImport. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.

Formulários de inscrição

• GET /v1/email-marketing/forms — Formulários de inscrição (dupla confirmação), mais recentes primeiro, uma página keyset. Operação listEmailMarketingForms. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, pelo MCP.
• POST /v1/email-marketing/forms — Crie um formulário de inscrição que adiciona pessoas confirmadas a uma lista. Operação createEmailMarketingForm. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, pelo MCP.
• DELETE /v1/email-marketing/forms/{form_id} — Exclua um formulário de inscrição (pessoas já confirmadas permanecem na lista). Operação deleteEmailMarketingForm. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, pelo MCP.
• PATCH /v1/email-marketing/forms/{form_id} — Altere um formulário de inscrição (redação, lista, redirecionamento, ativado ou desativado). Operação updateEmailMarketingForm. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, pelo MCP.

Conexões de envio

• GET /v1/email-marketing/senders — As conexões de envio da organização. Operação listEmailMarketingSenders. Permissões verificadas: email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/senders — Conecte um remetente de campanha (envio Zinn® ou o próprio servidor SMTP do cliente). Operação createEmailMarketingSender. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: somente API e painel: ele contém um segredo que nunca deve chegar a um modelo de IA (o corpo é a senha do SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — Remova uma conexão de envio e sua senha armazenada. Operação deleteEmailMarketingSender. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — Comprove que uma conexão de envio funciona, sem enviar nada. Operação verifyEmailMarketingSender. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Armazene o segredo de assinatura do webhook do seu provedor de e-mail para esta conexão. Operação setEmailMarketingSenderWebhook. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (armazena o segredo do webhook de um provedor).

SMS e WhatsApp

• GET /v1/email-marketing/sms — Do que a tela SMS precisa — aberto?, pausado?, saldo de créditos e preços. Operação getEmailMarketingSms. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/sms/campaigns — Campanhas de SMS em massa, as mais recentes primeiro, uma página keyset. Operação listSmsMarketingCampaigns. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/sms/campaigns — Crie um rascunho de SMS para uma lista. Operação createSmsMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Uma campanha de SMS em massa. Operação getSmsMarketingCampaign. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — Edite um rascunho (ou uma campanha recusada, que retorna para rascunho). Operação updateSmsMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — Os números de uma campanha de SMS em massa. Operação getSmsMarketingCampaignReport. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — Inicie o envio de um SMS para todas as pessoas da lista que concordaram em receber SMS — ou retome uma campanha pausada por falta de créditos. Operação sendSmsMarketingCampaign. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: apenas API e painel: gera custos em dinheiro ou consome franquia, portanto uma pessoa deve acioná-la (envia mensagens pagas de SMS/WhatsApp).
• GET /v1/email-marketing/sms/registrations/us — Registro US 10DLC desta organização e quanto ele custa. Operação getEmailMarketingUsRegistration. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/sms/registrations/us — Envie a marca e a campanha desta organização para o US 10DLC (cobrado no momento do envio). Operação submitEmailMarketingUsRegistration. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: apenas API e painel: gera custos em dinheiro ou consome franquia, portanto uma pessoa deve acioná-la (o registro US 10DLC acarreta taxas de operadora).

Campanhas por meio do seu próprio serviço de e-mail (modelos, segmentos, supressões)

• GET /v1/campaigns — As campanhas da organização. Operação listCampaigns. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns — Crie uma campanha a partir de um modelo e de um público. Operação createCampaign. De um assistente de IA: sim, por meio do MCP.
• DELETE /v1/campaigns/esp — Desconecte a conta do provedor e remova sua chave armazenada. Operação disconnectEsp. De um assistente de IA: apenas API e painel: contém um segredo que nunca deve chegar a um modelo de IA (destrói a chave ESP armazenada).
• GET /v1/campaigns/esp — A conta própria de provedor de e-mail da organização. Operação getEspConnection. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/esp — Conecte uma conta de provedor de e-mail. Operação connectEsp. De um assistente de IA: apenas API e painel: contém um segredo que nunca deve chegar a um modelo de IA (o corpo é a chave de API do ESP).
• POST /v1/campaigns/esp/verify — Comprove que a conta do provedor funciona e leia seus domínios verificados. Operação verifyEspConnection. De um assistente de IA: apenas API e painel: contém um segredo que nunca deve chegar a um modelo de IA (verifica novamente uma chave ESP armazenada).
• POST /v1/campaigns/preview — Execute Render de um modelo com valores de exemplo. Operação previewCampaignTemplate. De um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/segments — Seus segmentos de público salvos. Operação listCampaignSegments. Permissões verificadas: campaigns.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/segments — Salve um novo segmento de público. Operação createCampaignSegment. Permissões verificadas: campaigns.manage. De um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/segments/fields — O vocabulário de filtros, suas listas de valores e as tags mágicas. Operação getCampaignSegmentFields. Permissões verificadas: campaigns.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/segments/preview — Quantas pessoas isso alcança, quem são elas e quem é deixado de fora. Operação previewCampaignSegment. Permissões verificadas: campaigns.view. De um assistente de IA: sim, por meio do MCP.
• DELETE /v1/campaigns/segments/{segmentId} — Arquive um segmento. Operação archiveCampaignSegment. Permissões verificadas: campaigns.manage. De um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/segments/{segmentId} — Um segmento salvo. Operação getCampaignSegment. Permissões verificadas: campaigns.view. De um assistente de IA: sim, por meio do MCP.
• PATCH /v1/campaigns/segments/{segmentId} — Renomeie um segmento ou altere seus filtros. Operação updateCampaignSegment. Permissões verificadas: campaigns.manage. De um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/suppressions — Endereços que não devem receber comunicações de marketing. Operação listCampaignSuppressions. Permissões verificadas: campaigns.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/suppressions — Adicione um endereço à lista de supressão. Operação createCampaignSuppression. Permissões verificadas: campaigns.manage. De um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/tags — A paleta de tags mágicas oferecida pelo criador de campanhas. Operação listCampaignTags. A partir de um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/templates — Os modelos de campanha da organização. Operação listCampaignTemplates. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/templates — Crie um modelo de campanha. Operação createCampaignTemplate. A partir de um assistente de IA: sim, por meio do MCP.
• DELETE /v1/campaigns/templates/{templateId} — Arquive um modelo e desative suas fontes de tradução. Operação archiveCampaignTemplate. A partir de um assistente de IA: sim, por meio do MCP.
• GET /v1/campaigns/templates/{templateId} — Um modelo de campanha. Operação getCampaignTemplate. A partir de um assistente de IA: sim, por meio do MCP.
• PUT /v1/campaigns/templates/{templateId} — Edite um modelo de campanha. Operação updateCampaignTemplate. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/unsubscribe — Saia de uma lista de marketing. Nenhuma conta é necessária. Operação unsubscribeFromCampaigns. A partir de um assistente de IA: somente API e painel: carrega um segredo que nunca deve alcançar um modelo de IA (recebe o token assinado de cancelamento de inscrição do destinatário).
• DELETE /v1/campaigns/{campaignId} — Exclua uma campanha e desative suas linhas de entrega. Operação deleteCampaign. A partir de um assistente de IA: somente API e painel: requer uma permissão não oferecida a conexões de IA (excluir uma campanha ESP requer campaigns.send).
• GET /v1/campaigns/{campaignId} — Uma campanha e seu relatório de entrega. Operação getCampaign. De um assistente de IA: sim, por meio do MCP.
• POST /v1/campaigns/{campaignId}/control — Pausar, retomar ou cancelar um envio em andamento. Operação controlCampaign. De um assistente de IA: apenas API e painel: gasta dinheiro ou franquia, portanto uma pessoa deve acioná-lo (pausa/retoma um envio em tempo real).
• POST /v1/campaigns/{campaignId}/send — Iniciar o envio durável. Operação sendCampaign. De um assistente de IA: apenas API e painel: gasta dinheiro ou franquia, portanto uma pessoa deve acioná-lo (envia uma campanha ESP para destinatários reais).
• POST /v1/campaigns/{campaignId}/test — Enviar uma mensagem real no canal que a campanha realmente usará. Operação testSendCampaign. De um assistente de IA: apenas API e painel: necessita de uma permissão que não é oferecida a conexões de IA (um envio de teste ESP precisa de campaigns.send).

Páginas públicas e webhooks de entrada

• GET /v1/public/email-marketing/c/{token} — O contador de cliques. Registra um clique por destinatário e redireciona para o link original. Operação emailMarketingClick. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (o redirecionamento de rastreamento de cliques).
• GET /v1/public/email-marketing/f/{public_id} — Uma página hospedada de formulário de inscrição (sem login). Operação emailMarketingFormPage. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (a página pública do formulário de inscrição).
• POST /v1/public/email-marketing/f/{public_id} — Envie um formulário de inscrição (página hospedada, incorporação ou JSON). Operação emailMarketingFormSubmit. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (um visitante envia um formulário de inscrição).
• GET /v1/public/email-marketing/fc — A página de confirmação de dupla aceitação (sem login). Operação emailMarketingFormConfirmPage. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (a página de confirmação de dupla aceitação).
• POST /v1/public/email-marketing/fc — Confirme uma inscrição (adiciona a pessoa à lista com um registro de consentimento). Operação emailMarketingFormConfirm. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (um visitante confirma uma dupla aceitação).
• GET /v1/public/email-marketing/o/{token} — A imagem de rastreamento de aberturas (um GIF de 1x1). Conta uma abertura por destinatário. Operação emailMarketingOpenPixel. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (o pixel de rastreamento de abertura).
• GET /v1/public/email-marketing/u/{token} — O link de cancelamento de inscrição no rodapé (sem login). Operação emailMarketingUnsubscribePage. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (a página de cancelamento de inscrição).
• POST /v1/public/email-marketing/u/{token} — Cancelamento de inscrição em um clique RFC 8058 (e o botão "parar tudo" da página). Operação emailMarketingUnsubscribeOneClick. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (cancelamento de inscrição em um clique RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — O link de cancelamento de inscrição do e-mail de aquecimento do pool de marketing (sem login). Operação emailMarketingWarmupUnsubscribePage. De um assistente de IA: uma página que seus destinatários abrem a partir de um e-mail (a página de cancelamento de inscrição do aquecimento).
• POST /v1/public/email-marketing/warmup-u/{token} — Cancelamento de inscrição em um clique RFC 8058 do e-mail de aquecimento. Operação emailMarketingWarmupUnsubscribeOneClick. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (cancelamento de inscrição de aquecimento em um clique).
• POST /v1/webhooks/campaign-events — Ingerir um evento de entrega assinado do provedor de e-mail. Operação receiveCampaignDeliveryWebhook. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (webhook assinado de entrega do ESP).
• POST /v1/webhooks/campaigns/telnyx — Respostas de SMS recebidas (STOP / START) de nosso fornecedor de SMS. Operação receiveCampaignsTelnyxInbound. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (webhook assinado de entrada do Telnyx).
• POST /v1/webhooks/email-marketing/{connection_id} — Eventos de entrega do próprio provedor de e-mail de um cliente para uma conexão de envio. Operação receiveEmailMarketingProviderWebhook. De um assistente de IA: chamado por outro sistema (um provedor ou um visitante), não por você (webhook assinado de remetente-provedor).

Fluxos

• GET /v1/email-marketing/flows — Fluxos de e-mail (boas-vindas, drip, data anual), uma página de keyset. Operação listEmailMarketingFlows. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/flows — Criar um fluxo (ele começa como um rascunho). Operação createEmailMarketingFlow. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Excluir um fluxo e suas inscrições (suas execuções enviadas permanecem, como campanhas). Operação deleteEmailMarketingFlow. Permissões verificadas: email_marketing.manage, email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• GET /v1/email-marketing/flows/{flow_id} — Um fluxo com suas etapas e seu relatório (inscritos, em andamento, execuções e destinatários por etapa). Operação getEmailMarketingFlow. Permissões verificadas: email_marketing.view. De um assistente de IA: sim, por meio do MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — Altere um fluxo; steps, quando fornecido, substitui toda a sequência. Operação updateEmailMarketingFlow. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — Ative um fluxo; somente as pessoas que entrarem na lista a partir de agora são inscritas. Operação activateEmailMarketingFlow. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — Pause um fluxo; as etapas pendentes aguardam e ninguém novo recebe e-mails até que ele seja reativado. Operação pauseEmailMarketingFlow. Permissões verificadas: email_marketing.manage, email_marketing.view. A partir de um assistente de IA: sim, por meio do MCP.