Resend
Visão geral
Seção intitulada “Visão geral”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.
- Site oficial: https://resend.com/
- Documentação na Composio: docs.composio.dev/toolkits/resend
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API gerada no painel do Resend, usada para autenticar todas as requisições. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse resend.com e crie uma conta (ou faça login).
- No painel, clique em API Keys no menu lateral.
- Clique em Create API Key, dê um nome descritivo (ex.: “SquadOS”) e escolha o nível de permissão desejado.
- Copie a chave exibida — ela só é mostrada uma vez.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Resend. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
- 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Adicionar contato a segmento
Seção intitulada “Adicionar contato a segmento”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | O ID do contato a adicionar ao segmento. |
segment_id | string | Sim | O ID do segmento ao qual o contato será adicionado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Cancelar e-mail
Seção intitulada “Cancelar e-mail”RESEND_CANCEL_EMAIL
Cancela um e-mail agendado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do e-mail a cancelar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar chave de API
Seção intitulada “Criar chave de API”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da chave de API. Máximo de 50 caracteres. |
domain_id | string | Não | Restringe a chave de API ao envio de e-mails de um domínio específico. Usado apenas quando a permissão é sending_access. |
permission | string ("full_access" | "sending_access") | Não | Níveis de permissão da chave de API. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar audiência
Seção intitulada “Criar audiência”RESEND_CREATE_AUDIENCE
Cria uma lista de contatos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome da audiência a ser criada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato
Seção intitulada “Criar contato”RESEND_CREATE_CONTACT
Cria um contato no Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Sim | O endereço de e-mail do contato. Deve ser um endereço válido conforme RFC. |
lastName | string | Não | O sobrenome do contato. |
firstName | string | Não | O primeiro nome do contato. |
audienceId | string | Sim | O ID da audiência. |
unsubscribed | boolean | Não | Status de assinatura do contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar propriedade de contato
Seção intitulada “Criar propriedade de contato”RESEND_CREATE_CONTACT_PROPERTY
Cria uma nova propriedade de contato no Resend. Use quando precisar definir campos personalizados para contatos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key | string | Sim | A 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. |
type | string ("string" | "number") | Sim | O tipo da propriedade de contato. |
fallbackValue | string | Não | Valor padrão para a propriedade. Deve corresponder ao tipo definido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato v2
Seção intitulada “Criar contato v2”RESEND_CREATE_CONTACT_V2
Cria um novo contato no Resend. Use quando precisar adicionar um contato sem especificar uma audiência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Sim | O endereço de e-mail do contato. |
topics | array | Não | Lista de assinaturas de tópico com ID e status (opt_in ou opt_out). |
segments | array | Não | Lista de IDs de segmento nos quais matricular o contato. |
last_name | string | Não | O sobrenome do contato. |
first_name | string | Não | O primeiro nome do contato. |
properties | array | Não | Pares chave-valor personalizados para o contato. Cada propriedade deve ter uma chave e um valor. |
unsubscribed | boolean | Não | Status global de assinatura; quando verdadeiro, o contato cancela a assinatura de todos os broadcasts. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar domínio
Seção intitulada “Criar domínio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome do domínio a ser criado. |
region | string ("us-east-1" | "eu-west-1" | "sa-east-1" | "ap-northeast-1") | Não | A 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar template
Seção intitulada “Criar template”RESEND_CREATE_TEMPLATE
Cria um novo template de e-mail no Resend. Use quando precisar definir templates reutilizáveis com variáveis opcionais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from | string | Não | Endereço de e-mail do remetente. Para incluir um nome amigável, use o formato 'Seu Nome <remetente@dominio.com>'. |
html | string | Sim | A versão HTML do template. Use a sintaxe {{NOME_DA_VARIAVEL}} para referenciar variáveis. |
name | string | Sim | O nome do template. |
text | string | Não | A versão em texto simples do template. Se omitido, o Resend gera automaticamente a partir do HTML. |
alias | string | Não | O alias do template. Identificador alternativo ao ID do template. |
subject | string | Não | Assunto do e-mail para o template. |
reply_to | string | Não | Endereço de resposta. Para múltiplos endereços, envie como array de strings. |
variables | array | Não | Variáveis do template. Até 50 variáveis por template. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tópico
Seção intitulada “Criar tópico”RESEND_CREATE_TOPIC
Cria um novo tópico para segmentar sua audiência. Use quando precisar organizar contatos por interesses ou preferências.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | O nome do tópico. Máximo de 50 caracteres. |
visibility | string ("public" | "private") | Não | Visibilidade do tópico na página de cancelamento de assinatura. |
description | string | Não | A descrição do tópico. Máximo de 200 caracteres. |
defaultSubscription | string ("opt_in" | "opt_out") | Sim | Preferência padrão de assinatura para novos contatos. Não pode ser modificado após a criação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar webhook
Seção intitulada “Criar webhook”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
events | array | Sim | Array 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. |
endpoint | string | Sim | A URL para onde os eventos do webhook serão enviados. Deve ser um endpoint HTTPS válido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir chave de API
Seção intitulada “Excluir chave de API”RESEND_DELETE_API_KEY
Remove uma chave de API existente do Resend. Use quando precisar revogar ou excluir uma chave de API.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
api_key_id | string | Sim | O ID da chave de API a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir audiência
Seção intitulada “Excluir audiência”RESEND_DELETE_AUDIENCE
Remove uma audiência existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
audience_id | string | Sim | O ID da audiência a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir contato
Seção intitulada “Excluir contato”RESEND_DELETE_CONTACT
Exclui um contato no Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | O ID do contato. É necessário informar id ou email. |
email | string | Não | O e-mail do contato. É necessário informar id ou email. |
audienceId | string | Sim | O ID da audiência. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir contato por ID
Seção intitulada “Excluir contato por ID”RESEND_DELETE_CONTACT_BY_ID
Remove um contato existente pelo seu ID. Use quando precisar excluir um contato diretamente sem especificar uma audiência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do contato a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir propriedade de contato
Seção intitulada “Excluir propriedade de contato”RESEND_DELETE_CONTACT_PROPERTY
Remove uma propriedade de contato existente do Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_property_id | string | Sim | O ID da propriedade de contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir domínio
Seção intitulada “Excluir domínio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | Sim | O ID do domínio a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir segmento
Seção intitulada “Excluir segmento”RESEND_DELETE_SEGMENT
Remove um segmento existente. Use quando precisar excluir permanentemente um segmento pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
segment_id | string | Sim | O ID do segmento a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir template
Seção intitulada “Excluir template”RESEND_DELETE_TEMPLATE
Remove um template existente. Use quando precisar excluir um template do Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | Sim | O ID ou alias do template. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir tópico
Seção intitulada “Excluir tópico”RESEND_DELETE_TOPIC
Remove um tópico existente no Resend. Use quando precisar excluir um tópico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do tópico. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir webhook
Seção intitulada “Excluir webhook”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
webhook_id | string | Sim | O ID do webhook. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Duplicar template
Seção intitulada “Duplicar template”RESEND_DUPLICATE_TEMPLATE
Duplica um template existente via API do Resend. Use quando precisar criar uma cópia de um template existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | Sim | O ID ou alias do template a duplicar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter contato
Seção intitulada “Obter contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | O 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'). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter propriedade de contato
Seção intitulada “Obter propriedade de contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_property_id | string | Sim | O ID da propriedade de contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter anexo de e-mail
Seção intitulada “Obter anexo de e-mail”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | Sim | O ID do e-mail. |
attachment_id | string | Sim | O ID do anexo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter segmento
Seção intitulada “Obter segmento”RESEND_GET_SEGMENT
Recupera um único segmento pelo seu ID. Use quando precisar obter informações detalhadas de um segmento específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
segment_id | string | Sim | O ID do segmento a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter template
Seção intitulada “Obter template”RESEND_GET_TEMPLATE
Recupera um único template por ID ou alias do Resend. Use quando precisar visualizar os detalhes de um template.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | Sim | O ID ou alias do template a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter tópico
Seção intitulada “Obter tópico”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do tópico. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter webhook
Seção intitulada “Obter webhook”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
webhook_id | string | Sim | O ID do webhook. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os contatos
Seção intitulada “Listar todos os contatos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor 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. |
limit | integer | Não | Número de contatos a recuperar por requisição. Mínimo 1, máximo 100. Padrão: 20. |
before | string | Não | Cursor de paginação — recupera contatos antes deste ID (o próprio ID é excluído). Não pode ser usado com o parâmetro after. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar chaves de API
Seção intitulada “Listar chaves de API”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | O 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. |
limit | integer | Não | Número de chaves de API a recuperar. Se omitido, todas as chaves são retornadas em uma única resposta. |
before | string | Não | O 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar audiências
Seção intitulada “Listar audiências”RESEND_LIST_AUDIENCES
Lista todas as audiências.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | ID de cursor para paginação para frente. |
limit | integer | Não | Número máximo de resultados a retornar. Máximo: 100. |
before | string | Não | ID de cursor para paginação para trás. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar broadcasts
Seção intitulada “Listar broadcasts”RESEND_LIST_BROADCASTS
Recupera uma lista de broadcasts. Use quando precisar buscar todos os broadcasts ou paginar por eles.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | O 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. |
limit | integer | Não | Número de broadcasts a recuperar. Se não fornecido, todos os broadcasts são retornados. |
before | string | Não | O 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar propriedades de contato
Seção intitulada “Listar propriedades de contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Retorna itens após este cursor. |
limit | integer | Não | Número de itens a retornar. |
before | string | Não | Retorna itens antes deste cursor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar contatos
Seção intitulada “Listar contatos”RESEND_LIST_CONTACTS
Lista contatos no Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | ID de cursor para paginação para frente. |
limit | integer | Não | Número máximo de resultados a retornar. Máximo: 100. |
before | string | Não | ID de cursor para paginação para trás. |
audienceId | string | Sim | O ID da audiência. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar segmentos do contato
Seção intitulada “Listar segmentos do contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do contato. |
after | string | Não | ID de cursor para paginação para frente. |
limit | integer | Não | Número máximo de resultados a retornar. Máximo: 100. |
before | string | Não | ID de cursor para paginação para trás. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tópicos do contato
Seção intitulada “Listar tópicos do contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | ID de cursor para paginação para frente. |
limit | integer | Não | Número máximo de resultados a retornar. Máximo: 100. |
before | string | Não | ID de cursor para paginação para trás. |
contact_id | string | Sim | O ID do contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar domínios
Seção intitulada “Listar domínios”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar anexos de e-mail
Seção intitulada “Listar anexos de e-mail”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor de paginação para buscar resultados após este ID de anexo. Não pode ser usado com before. |
limit | integer | Não | Número máximo de anexos a retornar. Use para paginação. |
before | string | Não | Cursor de paginação para buscar resultados antes deste ID de anexo. Não pode ser usado com after. |
email_id | string | Sim | O ID do e-mail do qual recuperar os anexos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar e-mails
Seção intitulada “Listar e-mails”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor de paginação para buscar resultados após este ID de e-mail. Não pode ser usado com before. |
limit | integer | Não | Número máximo de e-mails a retornar. Padrão 20, máximo 100, mínimo 1. |
before | string | Não | Cursor de paginação para buscar resultados antes deste ID de e-mail. Não pode ser usado com after. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar e-mails recebidos
Seção intitulada “Listar e-mails recebidos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor de paginação para buscar resultados após este ID de e-mail. Não pode ser usado com before. |
limit | integer | Não | Número máximo de e-mails recebidos a retornar. |
before | string | Não | Cursor de paginação para buscar resultados antes deste ID de e-mail. Não pode ser usado com after. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar segmentos
Seção intitulada “Listar segmentos”RESEND_LIST_SEGMENTS
Recupera uma lista de segmentos do Resend. Use quando precisar visualizar todos os segmentos disponíveis para gerenciamento de audiência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Retorna itens após este cursor para paginação. |
limit | integer | Não | Número de itens a retornar. |
before | string | Não | Retorna itens antes deste cursor para paginação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar templates
Seção intitulada “Listar templates”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Retorna itens após este cursor. |
limit | integer | Não | Número de itens a retornar. |
before | string | Não | Retorna itens antes deste cursor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tópicos
Seção intitulada “Listar tópicos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Retorna itens após este cursor. |
limit | integer | Não | Número de itens a retornar. |
before | string | Não | Retorna itens antes deste cursor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar webhooks
Seção intitulada “Listar webhooks”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Cursor de paginação para buscar resultados após este ID de webhook. Não pode ser usado com before. |
limit | integer | Não | Número máximo de webhooks a retornar. |
before | string | Não | Cursor de paginação para buscar resultados antes deste ID de webhook. Não pode ser usado com after. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Publicar template
Seção intitulada “Publicar template”RESEND_PUBLISH_TEMPLATE
Publica um template via API do Resend. Use quando precisar tornar um template publicamente disponível.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
template_id | string | Sim | O ID ou alias do template a publicar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Remover contato do segmento
Seção intitulada “Remover contato do segmento”RESEND_REMOVE_CONTACT_FROM_SEGMENT
Remove um contato existente de um segmento. Use quando precisar desassociar um contato de um segmento específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | string | Sim | O ID do contato a remover do segmento. |
segment_id | string | Sim | O ID do segmento do qual o contato será removido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar audiência
Seção intitulada “Recuperar audiência”RESEND_RETRIEVE_AUDIENCE
Recupera uma única audiência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
audience_id | string | Sim | O ID da audiência a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar contato
Seção intitulada “Recuperar contato”RESEND_RETRIEVE_CONTACT
Recupera um contato no Resend.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do contato. |
audienceId | string | Sim | O ID da audiência. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar domínio
Seção intitulada “Recuperar domínio”RESEND_RETRIEVE_DOMAIN
Recupera um único domínio.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | Sim | O ID do domínio a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar e-mail
Seção intitulada “Recuperar e-mail”RESEND_RETRIEVE_EMAIL
Recupera um único e-mail.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_id | string | Sim | O ID do e-mail a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar e-mails em lote
Seção intitulada “Enviar e-mails em lote”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
emails | array | Sim | Lista de itens de e-mail a enviar em lote. Máximo de 100 e-mails por lote. |
Idempotency-Key | string | Não | Identificador único para a requisição, garantindo que os e-mails sejam enviados apenas uma vez. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Enviar e-mail
Seção intitulada “Enviar e-mail”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cc | string | Não | Endereço de e-mail para cópia (Cc). Para múltiplos endereços, envie como array de strings. |
to | string | Sim | Endereço de e-mail do destinatário. Para múltiplos endereços, envie como array de strings. Máximo de 50. |
bcc | string | Não | Endereç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. |
from | string | Sim | Endereço de e-mail do remetente. Para incluir um nome, use o formato 'Seu Nome <remetente@dominio.com>'. |
html | string | Não | A versão HTML da mensagem. Pelo menos um dos campos html ou text deve ser fornecido. |
text | string | Não | A versão em texto simples da mensagem. Pelo menos um dos campos html ou text deve ser fornecido. |
react | string | Não | A versão React da mensagem. Disponível apenas no SDK Node.js. |
headers | object | Não | Cabeçalhos personalizados a adicionar ao e-mail. Deve ser um dicionário/objeto com pares chave-valor (ex.: {'X-Custom-Header': 'valor'}). |
subject | string | Sim | Assunto do e-mail. |
reply_to | string | Não | Endereço de resposta. Para múltiplos endereços, envie como array de strings. |
scheduled_at | string | Não | Agenda o e-mail para ser enviado mais tarde. A data deve estar no formato ISO 8601 (ex.: '2024-08-05T11:52:01.858Z'). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar broadcast
Seção intitulada “Atualizar broadcast”RESEND_UPDATE_BROADCAST
Atualiza um broadcast existente no Resend. Use quando precisar modificar detalhes como nome, assunto, conteúdo ou destinatários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do broadcast a atualizar. |
from | string | Não | O endereço de e-mail do remetente. |
html | string | Não | A versão HTML da mensagem. |
name | string | Não | Nome do broadcast. |
text | string | Não | A versão em texto simples da mensagem. |
subject | string | Não | A linha de assunto do e-mail. |
reply_to | array | Não | Os endereços de e-mail para os quais as respostas devem ser enviadas. |
segment_id | string | Não | Identificador único do segmento para o qual este broadcast será enviado. |
audience_id | string | Não | Identificador único da audiência para a qual este broadcast será enviado. |
preview_text | string | Não | O texto de prévia do e-mail. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar contato
Seção intitulada “Atualizar contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
last_name | string | Não | O sobrenome do contato. |
first_name | string | Não | O primeiro nome do contato. |
id_or_email | string | Sim | O 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. |
unsubscribed | boolean | Não | Status de assinatura do contato. Quando verdadeiro, cancela a assinatura do contato de todos os broadcasts. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar propriedade de contato
Seção intitulada “Atualizar propriedade de contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
fallback_value | string | Não | O 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_id | string | Sim | O ID da propriedade de contato a atualizar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar domínio
Seção intitulada “Atualizar domínio”RESEND_UPDATE_DOMAIN
Atualiza um domínio existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tls | string ("opportunistic" | "enforced") | Não | Configuraçã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_id | string | Sim | O ID do domínio a atualizar. |
open_tracking | boolean | Não | Rastrear a taxa de abertura de cada e-mail. |
click_tracking | boolean | Não | Rastrear cliques no corpo de cada e-mail HTML. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar e-mail
Seção intitulada “Atualizar e-mail”RESEND_UPDATE_EMAIL
Atualiza um e-mail agendado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do e-mail a atualizar. |
scheduled_at | string | Sim | Agenda o e-mail para ser enviado mais tarde. A data deve estar no formato ISO 8601 (ex.: 2024-08-05T11:52:01.858Z). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar template
Seção intitulada “Atualizar template”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID ou alias do template a atualizar. |
from | string | Não | Endereço de e-mail do remetente. Para incluir um nome amigável, use o formato "Seu Nome <remetente@dominio.com>". |
html | string | Não | A versão HTML do template. |
name | string | Não | O nome do template. |
text | string | Não | A versão em texto simples do template. |
alias | string | Não | O alias do template. |
subject | string | Não | Assunto do e-mail. |
reply_to | array | Não | Endereços de resposta do e-mail. |
variables | array | Não | Variáveis do template com seus tipos e valores de fallback opcionais. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar tópico
Seção intitulada “Atualizar tópico”RESEND_UPDATE_TOPIC
Atualiza um tópico existente no Resend. Use quando precisar modificar o nome de um tópico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O ID do tópico a atualizar. |
name | string | Sim | O nome do tópico a atualizar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar webhook
Seção intitulada “Atualizar webhook”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
events | array | Não | Array de tipos de evento para assinar. Deve conter pelo menos um evento se fornecido. |
status | string ("enabled" | "disabled") | Não | O status do webhook. enabled para ativar; disabled para desativar. |
endpoint | string | Não | A URL para onde os eventos do webhook serão enviados. |
webhook_id | string | Sim | O ID do webhook a atualizar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Verificar domínio
Seção intitulada “Verificar domínio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
domain_id | string | Sim | O ID do domínio a verificar. Deve corresponder a um domínio registrado existente; use RESEND_LIST_DOMAINS para recuperar IDs válidos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |