Pular para o conteúdo

Resend

Resend

Resend é a API universal para envio de e-mails, projetada para desenvolvedores que precisam de entregabilidade confiável e uma experiência de integração simples. Com a integração Resend no SquadOS, seus agentes podem enviar e-mails transacionais, gerenciar audiências e contatos, configurar domínios verificados, criar templates reutilizáveis e monitorar eventos via webhooks em tempo real.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API gerada no painel do Resend, usada para autenticar todas as requisições.
  1. Acesse resend.com e crie uma conta (ou faça login).
  2. No painel, clique em API Keys no menu lateral.
  3. Clique em Create API Key, dê um nome descritivo (ex.: “SquadOS”) e escolha o nível de permissão desejado.
  4. Copie a chave exibida — ela só é mostrada uma vez.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Resend.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

RESEND_ADD_CONTACT_TO_SEGMENT

Adiciona um contato existente a um segmento no Resend. Use quando precisar organizar contatos em segmentos específicos para comunicação direcionada.

NomeTipoObrigatórioDescrição
contact_idstringSimO ID do contato a adicionar ao segmento.
segment_idstringSimO ID do segmento ao qual o contato será adicionado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CANCEL_EMAIL

Cancela um e-mail agendado.

NomeTipoObrigatórioDescrição
idstringSimO ID do e-mail a cancelar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_API_KEY

Cria uma nova chave de API para autenticar comunicações com o Resend. Use quando precisar gerar um novo token de autenticação para acesso à API.

NomeTipoObrigatórioDescrição
namestringSimNome da chave de API. Máximo de 50 caracteres.
domain_idstringNãoRestringe a chave de API ao envio de e-mails de um domínio específico. Usado apenas quando a permissão é sending_access.
permissionstring ("full_access" | "sending_access")NãoNíveis de permissão da chave de API.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_AUDIENCE

Cria uma lista de contatos.

NomeTipoObrigatórioDescrição
namestringSimO nome da audiência a ser criada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_CONTACT

Cria um contato no Resend.

NomeTipoObrigatórioDescrição
emailstringSimO endereço de e-mail do contato. Deve ser um endereço válido conforme RFC.
lastNamestringNãoO sobrenome do contato.
firstNamestringNãoO primeiro nome do contato.
audienceIdstringSimO ID da audiência.
unsubscribedbooleanNãoStatus de assinatura do contato.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_CONTACT_PROPERTY

Cria uma nova propriedade de contato no Resend. Use quando precisar definir campos personalizados para contatos.

NomeTipoObrigatórioDescrição
keystringSimA chave da propriedade de contato. Deve ser alfanumérica e permitir apenas underscore, máximo de 50 caracteres. Sensível a maiúsculas/minúsculas.
typestring ("string" | "number")SimO tipo da propriedade de contato.
fallbackValuestringNãoValor padrão para a propriedade. Deve corresponder ao tipo definido.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_CONTACT_V2

Cria um novo contato no Resend. Use quando precisar adicionar um contato sem especificar uma audiência.

NomeTipoObrigatórioDescrição
emailstringSimO endereço de e-mail do contato.
topicsarrayNãoLista de assinaturas de tópico com ID e status (opt_in ou opt_out).
segmentsarrayNãoLista de IDs de segmento nos quais matricular o contato.
last_namestringNãoO sobrenome do contato.
first_namestringNãoO primeiro nome do contato.
propertiesarrayNãoPares chave-valor personalizados para o contato. Cada propriedade deve ter uma chave e um valor.
unsubscribedbooleanNãoStatus global de assinatura; quando verdadeiro, o contato cancela a assinatura de todos os broadcasts.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_DOMAIN

Cria um domínio via API do Resend. O domínio é criado em estado pendente/não verificado e não pode ser usado para envio de e-mails até que a verificação de DNS seja concluída.

NomeTipoObrigatórioDescrição
namestringSimO nome do domínio a ser criado.
regionstring ("us-east-1" | "eu-west-1" | "sa-east-1" | "ap-northeast-1")NãoA região de onde os e-mails serão enviados. Valores aceitos: us-east-1, eu-west-1, sa-east-1. Valores inválidos causam erros de validação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_TEMPLATE

Cria um novo template de e-mail no Resend. Use quando precisar definir templates reutilizáveis com variáveis opcionais.

NomeTipoObrigatórioDescrição
fromstringNãoEndereço de e-mail do remetente. Para incluir um nome amigável, use o formato 'Seu Nome <remetente@dominio.com>'.
htmlstringSimA versão HTML do template. Use a sintaxe {{NOME_DA_VARIAVEL}} para referenciar variáveis.
namestringSimO nome do template.
textstringNãoA versão em texto simples do template. Se omitido, o Resend gera automaticamente a partir do HTML.
aliasstringNãoO alias do template. Identificador alternativo ao ID do template.
subjectstringNãoAssunto do e-mail para o template.
reply_tostringNãoEndereço de resposta. Para múltiplos endereços, envie como array de strings.
variablesarrayNãoVariáveis do template. Até 50 variáveis por template.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_TOPIC

Cria um novo tópico para segmentar sua audiência. Use quando precisar organizar contatos por interesses ou preferências.

NomeTipoObrigatórioDescrição
namestringSimO nome do tópico. Máximo de 50 caracteres.
visibilitystring ("public" | "private")NãoVisibilidade do tópico na página de cancelamento de assinatura.
descriptionstringNãoA descrição do tópico. Máximo de 200 caracteres.
defaultSubscriptionstring ("opt_in" | "opt_out")SimPreferência padrão de assinatura para novos contatos. Não pode ser modificado após a criação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_CREATE_WEBHOOK

Cria um webhook para receber notificações em tempo real sobre eventos de e-mail. Use quando precisar configurar notificações automáticas para mudanças de status de e-mail.

NomeTipoObrigatórioDescrição
eventsarraySimArray de tipos de evento para assinar. Eventos comuns: email.sent, email.delivered, email.delivery_delayed, email.complained, email.bounced, email.opened, email.clicked. Deve incluir pelo menos um evento.
endpointstringSimA URL para onde os eventos do webhook serão enviados. Deve ser um endpoint HTTPS válido.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_API_KEY

Remove uma chave de API existente do Resend. Use quando precisar revogar ou excluir uma chave de API.

NomeTipoObrigatórioDescrição
api_key_idstringSimO ID da chave de API a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_AUDIENCE

Remove uma audiência existente.

NomeTipoObrigatórioDescrição
audience_idstringSimO ID da audiência a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_CONTACT

Exclui um contato no Resend.

NomeTipoObrigatórioDescrição
idstringNãoO ID do contato. É necessário informar id ou email.
emailstringNãoO e-mail do contato. É necessário informar id ou email.
audienceIdstringSimO ID da audiência.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_CONTACT_BY_ID

Remove um contato existente pelo seu ID. Use quando precisar excluir um contato diretamente sem especificar uma audiência.

NomeTipoObrigatórioDescrição
idstringSimO ID do contato a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_CONTACT_PROPERTY

Remove uma propriedade de contato existente do Resend.

NomeTipoObrigatórioDescrição
contact_property_idstringSimO ID da propriedade de contato.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_DOMAIN

Exclui um domínio via API do Resend. A exclusão é irreversível; certifique-se de que nenhum tráfego de e-mail ativo ou configuração de DNS dependa do domínio antes de chamar esta ação.

NomeTipoObrigatórioDescrição
domain_idstringSimO ID do domínio a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_SEGMENT

Remove um segmento existente. Use quando precisar excluir permanentemente um segmento pelo seu ID.

NomeTipoObrigatórioDescrição
segment_idstringSimO ID do segmento a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_TEMPLATE

Remove um template existente. Use quando precisar excluir um template do Resend.

NomeTipoObrigatórioDescrição
template_idstringSimO ID ou alias do template.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_TOPIC

Remove um tópico existente no Resend. Use quando precisar excluir um tópico.

NomeTipoObrigatórioDescrição
idstringSimO ID do tópico.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DELETE_WEBHOOK

Remove um webhook existente. Use para excluir uma configuração de webhook quando não precisar mais receber notificações de eventos naquele endpoint.

NomeTipoObrigatórioDescrição
webhook_idstringSimO ID do webhook.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_DUPLICATE_TEMPLATE

Duplica um template existente via API do Resend. Use quando precisar criar uma cópia de um template existente.

NomeTipoObrigatórioDescrição
template_idstringSimO ID ou alias do template a duplicar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_CONTACT

Recupera um único contato do Resend por ID ou e-mail. Use quando precisar obter os detalhes de um contato específico usando o endpoint global de contatos.

NomeTipoObrigatórioDescrição
contact_idstringSimO ID ou endereço de e-mail do contato a recuperar. Pode ser um UUID (ex.: 'e169aa45-1ecf-4183-9955-b1499d5701d3') ou um endereço de e-mail (ex.: 'usuario@exemplo.com').
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_CONTACT_PROPERTY

Recupera uma única propriedade de contato do Resend. Use quando precisar obter detalhes de uma propriedade de contato específica pelo seu ID.

NomeTipoObrigatórioDescrição
contact_property_idstringSimO ID da propriedade de contato.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_EMAIL_ATTACHMENT

Recupera um único anexo de um e-mail enviado. Use quando precisar acessar metadados e URL de download de um anexo.

NomeTipoObrigatórioDescrição
email_idstringSimO ID do e-mail.
attachment_idstringSimO ID do anexo.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_SEGMENT

Recupera um único segmento pelo seu ID. Use quando precisar obter informações detalhadas de um segmento específico.

NomeTipoObrigatórioDescrição
segment_idstringSimO ID do segmento a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_TEMPLATE

Recupera um único template por ID ou alias do Resend. Use quando precisar visualizar os detalhes de um template.

NomeTipoObrigatórioDescrição
template_idstringSimO ID ou alias do template a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_TOPIC

Recupera um único tópico pelo seu ID no Resend. Use quando precisar buscar os detalhes de um tópico específico.

NomeTipoObrigatórioDescrição
idstringSimO ID do tópico.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_GET_WEBHOOK

Recupera um único webhook do usuário autenticado. Use para obter detalhes de uma configuração específica de webhook, incluindo endpoint, eventos assinados e segredo de assinatura.

NomeTipoObrigatórioDescrição
webhook_idstringSimO ID do webhook.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_ALL_CONTACTS

Recupera uma lista de todos os contatos do Resend. Use quando precisar buscar contatos em todas as audiências com paginação opcional.

NomeTipoObrigatórioDescrição
afterstringNãoCursor de paginação — recupera contatos após este ID (o próprio ID é excluído). Não pode ser usado com o parâmetro before.
limitintegerNãoNúmero de contatos a recuperar por requisição. Mínimo 1, máximo 100. Padrão: 20.
beforestringNãoCursor de paginação — recupera contatos antes deste ID (o próprio ID é excluído). Não pode ser usado com o parâmetro after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_API_KEYS

Recupera uma lista de chaves de API do usuário autenticado. Use quando precisar visualizar todas as chaves de API associadas à conta, com suporte a paginação para grandes conjuntos de resultados.

NomeTipoObrigatórioDescrição
afterstringNãoO ID após o qual mais chaves de API serão recuperadas (paginação). Este ID não será incluído na lista retornada. Não pode ser usado com o parâmetro before.
limitintegerNãoNúmero de chaves de API a recuperar. Se omitido, todas as chaves são retornadas em uma única resposta.
beforestringNãoO ID antes do qual mais chaves de API serão recuperadas (paginação). Este ID não será incluído na lista retornada. Não pode ser usado com o parâmetro after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_AUDIENCES

Lista todas as audiências.

NomeTipoObrigatórioDescrição
afterstringNãoID de cursor para paginação para frente.
limitintegerNãoNúmero máximo de resultados a retornar. Máximo: 100.
beforestringNãoID de cursor para paginação para trás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_BROADCASTS

Recupera uma lista de broadcasts. Use quando precisar buscar todos os broadcasts ou paginar por eles.

NomeTipoObrigatórioDescrição
afterstringNãoO ID após o qual mais broadcasts serão recuperados (paginação). Este ID não será incluído na lista retornada. Não pode ser usado com o parâmetro before.
limitintegerNãoNúmero de broadcasts a recuperar. Se não fornecido, todos os broadcasts são retornados.
beforestringNãoO ID antes do qual mais broadcasts serão recuperados (paginação). Este ID não será incluído na lista retornada. Não pode ser usado com o parâmetro after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_CONTACT_PROPERTIES

Recupera uma lista de propriedades de contato do Resend. Use quando precisar visualizar as definições de propriedades de contato disponíveis.

NomeTipoObrigatórioDescrição
afterstringNãoRetorna itens após este cursor.
limitintegerNãoNúmero de itens a retornar.
beforestringNãoRetorna itens antes deste cursor.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_CONTACTS

Lista contatos no Resend.

NomeTipoObrigatórioDescrição
afterstringNãoID de cursor para paginação para frente.
limitintegerNãoNúmero máximo de resultados a retornar. Máximo: 100.
beforestringNãoID de cursor para paginação para trás.
audienceIdstringSimO ID da audiência.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_CONTACT_SEGMENTS

Recupera uma lista de segmentos dos quais um contato faz parte. Use quando precisar determinar a quais segmentos um contato específico pertence.

NomeTipoObrigatórioDescrição
idstringSimO ID do contato.
afterstringNãoID de cursor para paginação para frente.
limitintegerNãoNúmero máximo de resultados a retornar. Máximo: 100.
beforestringNãoID de cursor para paginação para trás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_CONTACT_TOPICS

Recupera uma lista de assinaturas de tópico de um contato no Resend. Use quando precisar verificar a quais tópicos um contato específico está inscrito.

NomeTipoObrigatórioDescrição
afterstringNãoID de cursor para paginação para frente.
limitintegerNãoNúmero máximo de resultados a retornar. Máximo: 100.
beforestringNãoID de cursor para paginação para trás.
contact_idstringSimO ID do contato.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_DOMAINS

Lista todos os domínios. Use os IDs de domínio retornados como entrada para ferramentas como RESEND_VERIFY_DOMAIN que exigem um domain_id.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_EMAIL_ATTACHMENTS

Recupera uma lista de anexos de um e-mail enviado. Use quando precisar obter informações sobre arquivos anexados a um e-mail enviado via Resend.

NomeTipoObrigatórioDescrição
afterstringNãoCursor de paginação para buscar resultados após este ID de anexo. Não pode ser usado com before.
limitintegerNãoNúmero máximo de anexos a retornar. Use para paginação.
beforestringNãoCursor de paginação para buscar resultados antes deste ID de anexo. Não pode ser usado com after.
email_idstringSimO ID do e-mail do qual recuperar os anexos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_EMAILS

Recupera uma lista de e-mails enviados pela sua equipe. Use quando precisar buscar e-mails enviados da sua conta. Suporta paginação com limit, after e before.

NomeTipoObrigatórioDescrição
afterstringNãoCursor de paginação para buscar resultados após este ID de e-mail. Não pode ser usado com before.
limitintegerNãoNúmero máximo de e-mails a retornar. Padrão 20, máximo 100, mínimo 1.
beforestringNãoCursor de paginação para buscar resultados antes deste ID de e-mail. Não pode ser usado com after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_RECEIVED_EMAILS

Recupera uma lista de e-mails recebidos pelo usuário autenticado. Use quando precisar buscar e-mails recebidos do endpoint de recebimento.

NomeTipoObrigatórioDescrição
afterstringNãoCursor de paginação para buscar resultados após este ID de e-mail. Não pode ser usado com before.
limitintegerNãoNúmero máximo de e-mails recebidos a retornar.
beforestringNãoCursor de paginação para buscar resultados antes deste ID de e-mail. Não pode ser usado com after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_SEGMENTS

Recupera uma lista de segmentos do Resend. Use quando precisar visualizar todos os segmentos disponíveis para gerenciamento de audiência.

NomeTipoObrigatórioDescrição
afterstringNãoRetorna itens após este cursor para paginação.
limitintegerNãoNúmero de itens a retornar.
beforestringNãoRetorna itens antes deste cursor para paginação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_TEMPLATES

Recupera uma lista de templates do Resend. Use quando precisar obter todos os templates disponíveis com suporte a paginação opcional.

NomeTipoObrigatórioDescrição
afterstringNãoRetorna itens após este cursor.
limitintegerNãoNúmero de itens a retornar.
beforestringNãoRetorna itens antes deste cursor.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_TOPICS

Recupera uma lista de tópicos do usuário autenticado. Use quando precisar buscar os tópicos disponíveis com suporte a paginação opcional.

NomeTipoObrigatórioDescrição
afterstringNãoRetorna itens após este cursor.
limitintegerNãoNúmero de itens a retornar.
beforestringNãoRetorna itens antes deste cursor.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_LIST_WEBHOOKS

Recupera uma lista de webhooks do usuário autenticado. Use para visualizar todos os webhooks configurados com seus endpoints, tipos de evento e status.

NomeTipoObrigatórioDescrição
afterstringNãoCursor de paginação para buscar resultados após este ID de webhook. Não pode ser usado com before.
limitintegerNãoNúmero máximo de webhooks a retornar.
beforestringNãoCursor de paginação para buscar resultados antes deste ID de webhook. Não pode ser usado com after.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_PUBLISH_TEMPLATE

Publica um template via API do Resend. Use quando precisar tornar um template publicamente disponível.

NomeTipoObrigatórioDescrição
template_idstringSimO ID ou alias do template a publicar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_REMOVE_CONTACT_FROM_SEGMENT

Remove um contato existente de um segmento. Use quando precisar desassociar um contato de um segmento específico.

NomeTipoObrigatórioDescrição
contact_idstringSimO ID do contato a remover do segmento.
segment_idstringSimO ID do segmento do qual o contato será removido.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_RETRIEVE_AUDIENCE

Recupera uma única audiência.

NomeTipoObrigatórioDescrição
audience_idstringSimO ID da audiência a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_RETRIEVE_CONTACT

Recupera um contato no Resend.

NomeTipoObrigatórioDescrição
idstringSimO ID do contato.
audienceIdstringSimO ID da audiência.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_RETRIEVE_DOMAIN

Recupera um único domínio.

NomeTipoObrigatórioDescrição
domain_idstringSimO ID do domínio a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_RETRIEVE_EMAIL

Recupera um único e-mail.

NomeTipoObrigatórioDescrição
email_idstringSimO ID do e-mail a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_SEND_BATCH_EMAILS

Dispara até 100 e-mails em lote de uma vez. Use quando precisar enviar múltiplos e-mails em uma única requisição à API.

NomeTipoObrigatórioDescrição
emailsarraySimLista de itens de e-mail a enviar em lote. Máximo de 100 e-mails por lote.
Idempotency-KeystringNãoIdentificador único para a requisição, garantindo que os e-mails sejam enviados apenas uma vez.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_SEND_EMAIL

Envia um e-mail usando o Resend. Confirme os destinatários e o conteúdo antes de invocar — envios são irreversíveis. Todos os destinatários devem ser listados explicitamente via to, cc ou bcc; envio baseado em audiência não é suportado. Renderize HTML ou texto simples externamente antes de passar via html ou text.

NomeTipoObrigatórioDescrição
ccstringNãoEndereço de e-mail para cópia (Cc). Para múltiplos endereços, envie como array de strings.
tostringSimEndereço de e-mail do destinatário. Para múltiplos endereços, envie como array de strings. Máximo de 50.
bccstringNãoEndereço de e-mail para cópia oculta (Bcc). Para múltiplos endereços, envie como array de strings. Use bcc em vez de to quando enviar para múltiplos destinatários para evitar que vejam os endereços uns dos outros.
fromstringSimEndereço de e-mail do remetente. Para incluir um nome, use o formato 'Seu Nome <remetente@dominio.com>'.
htmlstringNãoA versão HTML da mensagem. Pelo menos um dos campos html ou text deve ser fornecido.
textstringNãoA versão em texto simples da mensagem. Pelo menos um dos campos html ou text deve ser fornecido.
reactstringNãoA versão React da mensagem. Disponível apenas no SDK Node.js.
headersobjectNãoCabeçalhos personalizados a adicionar ao e-mail. Deve ser um dicionário/objeto com pares chave-valor (ex.: {'X-Custom-Header': 'valor'}).
subjectstringSimAssunto do e-mail.
reply_tostringNãoEndereço de resposta. Para múltiplos endereços, envie como array de strings.
scheduled_atstringNãoAgenda o e-mail para ser enviado mais tarde. A data deve estar no formato ISO 8601 (ex.: '2024-08-05T11:52:01.858Z').
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_BROADCAST

Atualiza um broadcast existente no Resend. Use quando precisar modificar detalhes como nome, assunto, conteúdo ou destinatários.

NomeTipoObrigatórioDescrição
idstringSimO ID do broadcast a atualizar.
fromstringNãoO endereço de e-mail do remetente.
htmlstringNãoA versão HTML da mensagem.
namestringNãoNome do broadcast.
textstringNãoA versão em texto simples da mensagem.
subjectstringNãoA linha de assunto do e-mail.
reply_toarrayNãoOs endereços de e-mail para os quais as respostas devem ser enviadas.
segment_idstringNãoIdentificador único do segmento para o qual este broadcast será enviado.
audience_idstringNãoIdentificador único da audiência para a qual este broadcast será enviado.
preview_textstringNãoO texto de prévia do e-mail.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_CONTACT

Atualiza um contato existente no Resend por ID ou e-mail. Use quando precisar modificar detalhes do contato, como nome ou status de assinatura.

NomeTipoObrigatórioDescrição
last_namestringNãoO sobrenome do contato.
first_namestringNãoO primeiro nome do contato.
id_or_emailstringSimO ID ou endereço de e-mail do contato a atualizar. Pode ser o ID único (formato UUID) ou o endereço de e-mail do contato.
unsubscribedbooleanNãoStatus de assinatura do contato. Quando verdadeiro, cancela a assinatura do contato de todos os broadcasts.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_CONTACT_PROPERTY

Atualiza uma propriedade de contato existente no Resend. Apenas o fallback_value pode ser atualizado; os campos key e type não podem ser alterados após a criação.

NomeTipoObrigatórioDescrição
fallback_valuestringNãoO valor padrão a usar quando a propriedade não está definida para um contato. Deve corresponder ao tipo especificado no campo type da propriedade. Pode ser string ou número.
contact_property_idstringSimO ID da propriedade de contato a atualizar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_DOMAIN

Atualiza um domínio existente.

NomeTipoObrigatórioDescrição
tlsstring ("opportunistic" | "enforced")NãoConfiguração TLS para comunicação por e-mail. opportunistic: tenta sempre uma conexão segura. enforced: exige TLS para comunicação por e-mail.
domain_idstringSimO ID do domínio a atualizar.
open_trackingbooleanNãoRastrear a taxa de abertura de cada e-mail.
click_trackingbooleanNãoRastrear cliques no corpo de cada e-mail HTML.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_EMAIL

Atualiza um e-mail agendado.

NomeTipoObrigatórioDescrição
idstringSimO ID do e-mail a atualizar.
scheduled_atstringSimAgenda o e-mail para ser enviado mais tarde. A data deve estar no formato ISO 8601 (ex.: 2024-08-05T11:52:01.858Z).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_TEMPLATE

Atualiza um template de e-mail existente no Resend. Use quando precisar modificar propriedades do template, como nome, assunto, conteúdo HTML ou variáveis.

NomeTipoObrigatórioDescrição
idstringSimO ID ou alias do template a atualizar.
fromstringNãoEndereço de e-mail do remetente. Para incluir um nome amigável, use o formato "Seu Nome <remetente@dominio.com>".
htmlstringNãoA versão HTML do template.
namestringNãoO nome do template.
textstringNãoA versão em texto simples do template.
aliasstringNãoO alias do template.
subjectstringNãoAssunto do e-mail.
reply_toarrayNãoEndereços de resposta do e-mail.
variablesarrayNãoVariáveis do template com seus tipos e valores de fallback opcionais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_TOPIC

Atualiza um tópico existente no Resend. Use quando precisar modificar o nome de um tópico.

NomeTipoObrigatórioDescrição
idstringSimO ID do tópico a atualizar.
namestringSimO nome do tópico a atualizar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_UPDATE_WEBHOOK

Atualiza uma configuração de webhook existente. Use quando precisar modificar a URL do endpoint, alterar as assinaturas de eventos ou habilitar/desabilitar um webhook.

NomeTipoObrigatórioDescrição
eventsarrayNãoArray de tipos de evento para assinar. Deve conter pelo menos um evento se fornecido.
statusstring ("enabled" | "disabled")NãoO status do webhook. enabled para ativar; disabled para desativar.
endpointstringNãoA URL para onde os eventos do webhook serão enviados.
webhook_idstringSimO ID do webhook a atualizar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

RESEND_VERIFY_DOMAIN

Verifica um domínio via API do Resend. Os registros DNS precisam ser propagados completamente antes que a verificação seja bem-sucedida; evite novas tentativas imediatas após a configuração do DNS.

NomeTipoObrigatórioDescrição
domain_idstringSimO ID do domínio a verificar. Deve corresponder a um domínio registrado existente; use RESEND_LIST_DOMAINS para recuperar IDs válidos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.