Postmark

Visão geral

Postmark é um serviço de entrega de e-mail transacional focado em alta entregabilidade e rastreamento detalhado. Diferente de soluções genéricas de marketing, o Postmark é otimizado para e-mails de aplicação — confirmações de conta, redefinição de senha, notificações e afins. Com a integração Postmark no SquadOS, seus agentes podem enviar e-mails, criar e gerenciar templates, monitorar bounces, gerenciar listas de supressão e analisar estatísticas completas de abertura, cliques e entregabilidade.

• Site oficial: https://postmarkapp.com/
• Documentação na Composio: docs.composio.dev/toolkits/postmark

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	Server Token do Postmark, usado no cabeçalho X-Postmark-Server-Token para autenticar todas as requisições da API.

Como obter a credencial

1. Acesse account.postmarkapp.com/login e faça login na sua conta Postmark.
2. Na tela principal de servidores, clique no servidor ao qual deseja conectar (ou crie um novo clicando em Create Server).
3. Dentro do servidor, clique na aba API Tokens.
4. Copie o valor do Server Token exibido — esse é o valor a usar no campo api_key ao conectar no SquadOS.

Dica

Cada servidor Postmark tem seu próprio token. Use tokens separados por ambiente (produção, desenvolvimento) para isolar dados e facilitar a revogação sem impactar outros servidores. Para testes, o token especial POSTMARK_API_TEST envia e-mails sem entrega real.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Postmark.
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 o Server Token obtido 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.)

Ações disponíveis

Arquivar stream de mensagens

POSTMARK_ARCHIVE_MESSAGE_STREAM

Arquiva um stream de mensagens (exclusão suave). Use quando precisar remover um stream que será excluído permanentemente após 45 dias.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
stream_id	string	Sim	O ID do stream de mensagens a arquivar

Saída

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 pontuação de spam

POSTMARK_CHECK_SPAM_SCORE

Avalia a pontuação de spam de um e-mail bruto via API SpamCheck. Use quando tiver o código-fonte completo do e-mail e precisar verificar a pontuação de spam antes de enviar. Retorna a pontuação e um relatório detalhado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
email	string	Sim	Código-fonte completo do e-mail bruto a analisar para pontuação de spam
options	string	Não	Nível de detalhe do relatório: short, long ou summary. Padrão: short.

Saída

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 regra de entrada

POSTMARK_CREATE_INBOUND_RULE

Cria um novo gatilho de regra de entrada para bloquear e-mails de um remetente ou domínio específico. Use quando precisar impedir que e-mails de endereços ou domínios específicos sejam processados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Rule	string	Sim	Endereço de e-mail ou domínio a bloquear nas mensagens de entrada (ex.: [email protected] ou baddomain.com)

Saída

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 stream de mensagens

POSTMARK_CREATE_MESSAGE_STREAM

Cria um novo stream de mensagens. Use quando precisar configurar streams separados para e-mails transacionais ou em massa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ID	string	Sim	O identificador do stream (ex.: transactional-dev). Deve ser único dentro do servidor.
Name	string	Sim	O nome do stream de mensagens
Description	string	Não	Uma descrição do stream de mensagens
MessageStreamType	string	Sim	O tipo de stream: Transactional para e-mails transacionais ou Broadcasts para e-mails em massa

Saída

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 supressões

POSTMARK_CREATE_SUPPRESSIONS

Adiciona endereços de e-mail à lista de supressão de um stream de mensagens. Use quando precisar impedir o envio de e-mails para endereços específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
stream_id	string	Sim	O ID do stream de mensagens (ex.: outbound, broadcast)
Suppressions	array	Sim	Array de endereços de e-mail a suprimir (máximo 50 por requisição)

Saída

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

POSTMARK_CREATE_TEMPLATE

Cria um novo template de e-mail. Use quando precisar de templates reutilizáveis antes de enviar e-mails.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Name	string	Sim	Nome do template (máximo 255 caracteres)
Alias	string	Não	Alias único do template (máximo 100 caracteres)
Subject	string	Sim	Linha de assunto do template, pode incluir variáveis, ex.: {{name}}
HtmlBody	string	Sim	Conteúdo HTML do template
TextBody	string	Sim	Conteúdo em texto simples do template
TemplateType	string	Sim	Tipo do template: Standard ou Layout
LayoutTemplate	string	Não	Alias ou ID de um template de layout (necessário para templates Standard que usam um layout)
AssociatedServerId	integer	Não	ID do servidor ao qual associar este template

Saída

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

POSTMARK_CREATE_WEBHOOK

Cria uma nova configuração de webhook para o Postmark. Use quando precisar configurar um webhook para receber notificações de eventos de rastreamento de e-mail (aberturas, cliques, bounces, entregas, etc.).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Url	string	Sim	O endpoint URL do webhook onde os eventos serão enviados.
HttpAuth	object	Não	Credenciais de autenticação HTTP para o endpoint do webhook.
Triggers	object	Não	Define quais eventos disparam este webhook.
HttpHeaders	array	Não	Array opcional de cabeçalhos customizados a incluir nas requisições do webhook.
MessageStream	string	Não	O stream de mensagens para este webhook (ex.: outbound, inbound). Padrão: outbound.

Saída

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 regra de entrada

POSTMARK_DELETE_INBOUND_RULE

Exclui um gatilho de regra de entrada específico. Use quando precisar remover uma regra de entrada pelo seu ID após confirmar que não é mais necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
triggerid	integer	Sim	O ID da regra de entrada a excluir.

Saída

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 supressões

POSTMARK_DELETE_SUPPRESSIONS

Remove endereços de e-mail da lista de supressão de um stream de mensagens. Use quando precisar reativar endereços de e-mail previamente suprimidos. Apenas supressões do tipo HardBounce e ManualSuppression podem ser removidas; supressões do tipo SpamComplaint não podem ser excluídas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
stream_id	string	Sim	O identificador único do stream de mensagens (ex.: outbound, inbound)
Suppressions	array	Sim	Array de endereços de e-mail a remover da lista de supressão (máximo 50 por requisição). Supressões do tipo SpamComplaint não podem ser excluídas, apenas HardBounce e ManualSuppression.

Saída

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

POSTMARK_DELETE_TEMPLATE

Exclui um template pelo seu ID ou alias. Use quando precisar remover permanentemente um template após confirmar que não é mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
templateIdOrAlias	string	Sim	O valor TemplateID (numérico) ou Alias (string) do template a excluir

Saída

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

POSTMARK_DELETE_WEBHOOK

Exclui um webhook específico. Use quando precisar remover um webhook pelo seu ID após confirmar que não é mais necessário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
webhookID	integer	Sim	ID do webhook a excluir

Saída

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.

Editar servidor

POSTMARK_EDIT_SERVER

Atualiza as configurações do servidor Postmark atual. Use quando precisar modificar a configuração do servidor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Name	string	Sim	Nome do servidor.
Color	string	Não	Código de cor hexadecimal do servidor, ex.: #FF0000.
OpenHookUrl	string	Não	URL para enviar eventos de webhook de abertura.
BounceHookUrl	string	Não	URL para enviar eventos de webhook de bounce.
InboundDomain	string	Não	Domínio para gerenciar e-mails de entrada.
InboundHookUrl	string	Não	URL para enviar eventos de webhook de e-mail de entrada.
DeliveryHookUrl	string	Não	URL para enviar eventos de webhook de entrega.
RawEmailEnabled	boolean	Não	Habilitar ou desabilitar suporte a e-mail bruto.
SmtpApiActivated	boolean	Não	Habilitar ou desabilitar a API SMTP para o servidor.
PostFirstOpenOnly	boolean	Não	Enviar webhook de abertura apenas no primeiro evento de abertura.
InboundSpamThreshold	integer	Não	Limite de pontuação de spam para e-mail de entrada; deve ser não-negativo.

Saída

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.

Editar template

POSTMARK_EDIT_TEMPLATE

Atualiza um template Postmark existente pelo seu ID. Use quando precisar modificar o nome, assunto, corpo HTML ou texto, alias, tipo, layout ou status ativo de um template.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Name	string	Não	Novo nome para o template
Alias	string	Não	Alias para localização mais fácil do template
Active	boolean	Não	Se o template deve estar ativo (true) ou inativo (false)
Subject	string	Não	Linha de assunto do template
HtmlBody	string	Não	Conteúdo HTML do template
TextBody	string	Não	Conteúdo em texto simples do template
templateID	integer	Sim	O ID único do template a atualizar
TemplateType	string	Não	Tipo do template: Standard ou Layout
LayoutTemplate	string	Não	Alias de um template de layout para envolver este template (para templates Standard)

Saída

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.

Editar webhook

POSTMARK_EDIT_WEBHOOK

Atualiza a URL ou os gatilhos de um webhook existente. Use quando precisar modificar as configurações do webhook após confirmar o webhookID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Url	string	Sim	A URL para receber os POSTs do webhook
Triggers	object	Sim	Gatilhos de evento para o webhook; as chaves são nomes de evento, os valores indicam se está habilitado
AuthToken	string	Não	Token secreto opcional para autenticar chamadas do webhook
webhookID	integer	Sim	ID do webhook a atualizar

Saída

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 contagens de bounces

POSTMARK_GET_BOUNCE_COUNTS

Obtém as contagens totais de e-mails retornados como bounce. Use quando precisar de estatísticas agregadas de bounce e detalhamento diário por tipo (hard bounce, soft bounce, transient, erros SMTP API).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar estatísticas de bounce por uma tag específica.
todate	string	Não	Filtrar estatísticas até esta data (formato YYYY-MM-DD).
fromdate	string	Não	Filtrar estatísticas a partir desta data (formato YYYY-MM-DD).

Saída

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 bounces

POSTMARK_GET_BOUNCES

Recupera uma lista de bounces para um servidor com filtros opcionais. Use quando precisar paginar pelos dados de bounce após aplicar filtros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar bounces enviados com esta tag.
type	string	Não	Filtrar por tipo de bounce. Correspondência exata, ex.: HardBounce, Transient, SoftBounce, SpamComplaint.
count	integer	Não	Número de bounces a retornar por página (1-500).
offset	integer	Não	Número de bounces a pular para paginação.
todate	string	Não	Incluir apenas bounces anteriores a esta data/hora ISO-8601.
fromdate	string	Não	Incluir apenas bounces após esta data/hora ISO-8601.
inactive	boolean	Não	Se true, retornar apenas bounces inativos.
messageID	string	Não	Retornar bounces para este ID de mensagem específico.
emailFilter	string	Não	Retornar bounces para este endereço de e-mail específico.
mailboxHash	string	Não	Filtrar pelo hash da caixa de correio (a parte após + no e-mail).

Saída

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 uso por plataforma de navegador

POSTMARK_GET_BROWSER_PLATFORM_USAGE

Recupera estatísticas de uso de plataforma de navegador para links clicados. Use após enviar e-mails com links rastreados para analisar o engajamento por navegador.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtro opcional por tag para restringir as estatísticas a e-mails específicos
todate	string	Não	Data de fim do filtro (inclusive) no formato YYYY-MM-DD, ex.: 2024-02-01
fromdate	string	Não	Data de início do filtro (inclusive) no formato YYYY-MM-DD, ex.: 2024-01-01
messagestream	string	Não	Filtro opcional por stream de mensagens; inclui todos os streams se omitido

Saída

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 uso de navegador

POSTMARK_GET_BROWSER_USAGE

Recupera estatísticas de uso de navegador para links clicados. Use após enviar e-mails rastreados para analisar quais navegadores e plataformas foram usados para clicar nos links.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ToDate	string	Sim	Data de fim do intervalo de estatísticas no formato YYYY-MM-DD.
FromDate	string	Sim	Data de início do intervalo de estatísticas no formato YYYY-MM-DD.
ServerID	integer	Não	Filtrar estatísticas por ID do servidor (opcional)

Saída

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 contagens de cliques

POSTMARK_GET_CLICK_COUNTS

Recupera contagens totais de cliques em todos os links dos e-mails. Use quando precisar de métricas agregadas de clique para um intervalo de datas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
os	string	Não	Filtrar por sistema operacional.
tag	string	Não	Filtrar por tag específica.
todate	string	Sim	Data de fim do intervalo no formato YYYY-MM-DD.
country	string	Não	Filtrar por código de país.
fromdate	string	Sim	Data de início do intervalo no formato YYYY-MM-DD.
platform	string	Não	Filtrar por plataforma do cliente.
client_name	string	Não	Filtrar por nome do cliente.

Saída

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 cliques por família de navegador

POSTMARK_GET_CLICKS_BY_BROWSER_FAMILY

Recupera estatísticas de cliques agrupadas por família de navegador. Use após enviar e-mails com links rastreados para analisar quais famílias de navegador os destinatários usaram para clicar. Requer que o rastreamento de links esteja habilitado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag específica para restringir as estatísticas a e-mails com esta tag
todate	string	Não	Data de fim do filtro (inclusive) no formato YYYY-MM-DD
fromdate	string	Não	Data de início do filtro (inclusive) no formato YYYY-MM-DD

Saída

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 cliques por localização

POSTMARK_GET_CLICKS_BY_LOCATION

Obtém uma visão geral de qual parte do e-mail os links foram clicados (HTML ou Texto). Use quando precisar analisar padrões de clique por tipo de conteúdo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag.
todate	string	Não	Filtrar estatísticas até a data especificada no formato YYYY-MM-DD.
fromdate	string	Não	Filtrar estatísticas a partir da data especificada no formato YYYY-MM-DD.

Saída

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 estatísticas de entrega

POSTMARK_GET_DELIVERY_STATS

Recupera estatísticas de entrega. Use após enviar e-mails para obter contagens agregadas de entregas, bounces e reclamações de spam.

Saída

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 uso de cliente de e-mail

POSTMARK_GET_EMAIL_CLIENT_USAGE

Recupera estatísticas sobre os clientes de e-mail usados para abrir e-mails. Use quando precisar analisar quais clientes os destinatários usam para abrir seus e-mails de saída.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por nome de tag (se os e-mails foram enviados com uma tag)
todate	string	Não	Data de fim das estatísticas (inclusive, formato: YYYY-MM-DD)
fromdate	string	Não	Data de início das estatísticas (inclusive, formato: YYYY-MM-DD)
messagestream	string	Não	Filtrar por ID do stream de mensagens. Se omitido, retorna estatísticas de todos os streams do servidor.

Saída

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 contagens de abertura de e-mail

POSTMARK_GET_EMAIL_OPEN_COUNTS

Recupera contagens de e-mails abertos. Use quando precisar de estatísticas diárias e totais de abertura para um período especificado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ToDate	string	Não	Incluir atividade anterior a esta data/hora ISO8601.
FromDate	string	Não	Incluir atividade a partir desta data/hora ISO8601.
MessageStream	string	Não	Filtrar estatísticas por um stream de mensagens específico.

Saída

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 stream de mensagens

POSTMARK_GET_MESSAGE_STREAM

Recupera detalhes de um stream de mensagens específico pelo seu ID. Use quando precisar inspecionar a configuração do stream como tipo, descrição ou configurações de assinatura.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
streamID	string	Sim	O ID do stream de mensagens a recuperar (ex.: outbound, inbound ou ID de stream personalizado)

Saída

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 aberturas por plataforma

POSTMARK_GET_OPENS_BY_PLATFORM

Recupera estatísticas de abertura de e-mail por tipo de plataforma. Use quando precisar entender quais plataformas os destinatários usam para abrir e-mails.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag para restringir as estatísticas a e-mails específicos
todate	string	Não	Data de fim do filtro (inclusive) no formato YYYY-MM-DD, ex.: 2014-02-01
fromdate	string	Não	Data de início do filtro (inclusive) no formato YYYY-MM-DD, ex.: 2014-01-01

Saída

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 visão geral de saída

POSTMARK_GET_OUTBOUND_OVERVIEW

Recupera uma visão geral das estatísticas de e-mail de saída. Use quando precisar de métricas agregadas de saída após enviar e-mails.

Saída

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 contagens de envio

POSTMARK_GET_SENT_COUNTS

Recupera a contagem total de e-mails enviados. Use quando precisar de estatísticas diárias e totais de envio para um período especificado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag específica para obter contagens de envio de e-mails com aquela tag.
todate	string	Não	Data de fim do intervalo no formato YYYY-MM-DD. Se não fornecida, padrão: hoje.
fromdate	string	Não	Data de início do intervalo no formato YYYY-MM-DD. Se não fornecida, padrão: 30 dias atrás.

Saída

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 servidor

POSTMARK_GET_SERVER

Recupera detalhes do servidor Postmark atual. Use quando precisar inspecionar a configuração do servidor (webhooks, rastreamento, tokens, etc.) antes de outras operações.

Saída

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 reclamações de spam

POSTMARK_GET_SPAM_COMPLAINTS

Recupera contagens de reclamações de spam. Use ao analisar tendências de feedback de spam após enviar campanhas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag associada aos e-mails
to_date	string	Não	Filtrar estatísticas até esta data inclusive (formato YYYY-MM-DD)
from_date	string	Não	Filtrar estatísticas a partir desta data (formato YYYY-MM-DD)

Saída

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

POSTMARK_GET_TEMPLATE

Recupera detalhes de um template específico pelo seu ID. Use após obter um ID de template para inspecionar sua configuração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
templateID	integer	Sim	O ID numérico único do template a recuperar

Saída

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 contagens de e-mails rastreados

POSTMARK_GET_TRACKED_EMAIL_COUNTS

Recupera contagens de e-mails com rastreamento habilitado. Use após especificar um intervalo de datas para analisar métricas de abertura e clique.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
todate	string	Sim	Data de fim do período de rastreamento no formato YYYY-MM-DD
fromdate	string	Sim	Data de início do período de rastreamento no formato YYYY-MM-DD

Saída

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

POSTMARK_GET_WEBHOOK

Recupera detalhes de um webhook específico pelo seu ID. Use quando precisar inspecionar a configuração do webhook incluindo URL, gatilhos e configurações de stream de mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
webhook_id	integer	Sim	O identificador único do webhook a recuperar

Saída

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 regras de entrada

POSTMARK_LIST_INBOUND_RULES

Lista todas as regras de entrada (gatilhos) configuradas para bloqueio de remetentes. Use quando precisar recuperar as regras de entrada configuradas com suporte a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número de regras de entrada a retornar por página. Exigido pela API.
offset	integer	Não	Número de regras de entrada a pular para paginação. Exigido pela API.

Saída

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 streams de mensagens

POSTMARK_LIST_MESSAGE_STREAMS

Lista todos os streams de mensagens de um servidor Postmark com filtragem opcional por tipo e arquivamento. Use quando precisar recuperar os streams disponíveis. Um servidor pode ter até 10 streams, incluindo os padrões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
MessageStreamType	string	Não	Opções de tipo de stream de mensagens para filtragem: Transactional, Broadcasts, Inbound ou all.
IncludeArchivedStreams	boolean	Não	Incluir streams arquivados na resposta.

Saída

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 cliques em mensagens de saída

POSTMARK_LIST_OUTBOUND_MESSAGE_CLICKS

Lista cliques em mensagens de saída com opções de filtragem. Use quando precisar recuperar eventos de clique com paginação e filtros opcionais como destinatário, tag, cliente, sistema operacional, plataforma ou localização geográfica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag associada à mensagem.
city	string	Não	Filtrar pelo nome completo da cidade onde as mensagens foram clicadas, ex.: Moscow, New York.
count	integer	Sim	Número de cliques de mensagem a retornar por requisição. Máximo 500.
offset	integer	Sim	Número de mensagens a pular para paginação.
region	string	Não	Filtrar pelo nome completo da região onde as mensagens foram clicadas.
country	string	Não	Filtrar pelo país onde as mensagens foram clicadas, ex.: Denmark, Russia.
os_name	string	Não	Filtrar pelo nome completo do SO e versão específica, ex.: OS X 10.9 Mavericks, Windows 7.
platform	string	Não	Filtrar por plataforma, ex.: webmail, desktop, mobile.
os_family	string	Não	Filtrar pelo tipo de SO sem versão específica, ex.: OS X, Windows.
recipient	string	Não	Filtrar por endereço de e-mail do destinatário (To, Cc ou Bcc).
os_company	string	Não	Filtrar pela empresa que produziu o SO, ex.: Apple Computer, Inc., Microsoft Corporation.
client_name	string	Não	Filtrar por nome do cliente, ex.: Outlook, Gmail.
client_family	string	Não	Filtrar por família do cliente, ex.: OS X, Chrome.
client_company	string	Não	Filtrar pela empresa que fabrica o cliente, ex.: Microsoft, Apple, Google.

Saída

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 aberturas de mensagens de saída

POSTMARK_LIST_OUTBOUND_MESSAGE_OPENS

Recupera aberturas de mensagens de saída com opções de filtragem. Use quando precisar analisar eventos de abertura de e-mail com dados detalhados de cliente, SO e localização geográfica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag da mensagem.
city	string	Não	Filtrar pela cidade onde as mensagens foram abertas, ex.: Moscow, New York, San Francisco.
count	integer	Não	Número de aberturas de mensagem a retornar por requisição. Máximo 500.
offset	integer	Não	Número de mensagens a pular para paginação.
region	string	Não	Filtrar pelo nome completo da região onde as mensagens foram abertas.
country	string	Não	Filtrar pelo país onde as mensagens foram abertas, ex.: Denmark, Russia, United States.
os_name	string	Não	Filtrar pelo nome completo do SO e versão específica, ex.: OS X 10.9 Mavericks, Windows 7.
platform	string	Não	Filtrar por tipo de plataforma, ex.: webmail, desktop, mobile.
os_family	string	Não	Filtrar pelo tipo de SO sem versão específica, ex.: OS X, Windows, Linux.
recipient	string	Não	Filtrar por endereço de e-mail do destinatário (To, Cc ou Bcc).
os_company	string	Não	Filtrar pela empresa que produziu o SO, ex.: Apple Computer, Inc., Microsoft Corporation.
client_name	string	Não	Filtrar por nome do cliente, ex.: Outlook, Gmail, Chrome.
client_family	string	Não	Filtrar por família do cliente, ex.: OS X, Chrome, Firefox.
client_company	string	Não	Filtrar pela empresa do cliente, ex.: Microsoft, Apple, Google.

Saída

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 supressões

POSTMARK_LIST_SUPPRESSIONS

Recupera a lista de supressão de um stream de mensagens com filtragem opcional. Use quando precisar visualizar todos os endereços de e-mail suprimidos de um stream.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Origin	string	Não	Origem da entrada de supressão: Recipient, Customer ou Admin.
todate	string	Não	Incluir supressões até esta data (formato: YYYY-MM-DD, ex.: 2020-02-01)
fromdate	string	Não	Incluir supressões a partir desta data (formato: YYYY-MM-DD, ex.: 2020-02-01)
stream_id	string	Sim	O ID do stream de mensagens para recuperar as supressões (ex.: outbound, broadcast)
EmailAddress	string	Não	Filtrar resultados por endereço de e-mail específico
SuppressionReason	string	Não	Motivo da supressão do e-mail: HardBounce, SpamComplaint ou ManualSuppression.

Saída

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

POSTMARK_LIST_TEMPLATES

Lista todos os templates de um servidor Postmark. Use quando precisar recuperar os templates disponíveis com paginação e filtros opcionais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número de templates a retornar por página (1-500). Exigido pela API.
offset	integer	Não	Número de templates a pular para paginação. Exigido pela API.
templateType	string	Não	Filtrar templates por tipo: Layout ou Standard.
templateActive	string	Não	Filtrar templates por status: true, false ou true,false.

Saída

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

POSTMARK_LIST_WEBHOOKS

Lista todos os webhooks configurados para a sua conta Postmark. Use após autenticar o token do servidor para recuperar as configurações atuais de webhook.

Saída

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.

Pesquisar mensagens de entrada

POSTMARK_SEARCH_INBOUND_MESSAGES

Pesquisa mensagens de entrada recebidas com filtragem opcional. Use quando precisar recuperar e-mails de entrada com paginação e vários filtros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag.
count	integer	Não	Número de mensagens a retornar por requisição. Máximo 500.
offset	integer	Não	Número de mensagens a pular para paginação.
status	string	Não	Status das mensagens de entrada: blocked, processed, queued, failed ou scheduled.
todate	string	Não	Filtrar mensagens até a data especificada, ex.: 2014-02-01
subject	string	Não	Filtrar por assunto do e-mail.
fromdate	string	Não	Filtrar mensagens a partir da data especificada, ex.: 2014-02-01
fromemail	string	Não	Filtrar pelo endereço de e-mail do remetente.
recipient	string	Não	Filtrar pelo usuário que estava recebendo o e-mail.
mailboxhash	string	Não	Filtrar pelo hash da caixa de correio.

Saída

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.

Pesquisar mensagens de saída

POSTMARK_SEARCH_OUTBOUND_MESSAGES

Pesquisa mensagens de saída com filtragem por destinatário, tag, status e intervalo de datas. Use quando precisar consultar mensagens enviadas com filtros específicos ou paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tag	string	Não	Filtrar por tag.
count	integer	Não	Número de mensagens a retornar por requisição. Máximo 500. Exigido pela API.
offset	integer	Não	Número de mensagens a pular para paginação. Exigido pela API.
status	string	Não	Status de uma mensagem de saída: queued ou sent.
todate	string	Não	Filtrar mensagens até a data especificada. Formato: YYYY-MM-DD (ex.: 2014-02-01).
fromdate	string	Não	Filtrar mensagens a partir da data especificada. Formato: YYYY-MM-DD (ex.: 2014-02-01).
fromemail	string	Não	Filtrar pelo endereço de e-mail do remetente.
recipient	string	Não	Filtrar pelo usuário que estava recebendo o e-mail.

Saída

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 templados em lote

POSTMARK_SEND_BATCH_WITH_TEMPLATES

Envia múltiplos e-mails baseados em templates em uma única chamada de API em lote. Use quando precisar enviar até 500 mensagens templadas de uma vez.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Messages	array	Sim	Lista de mensagens templadas a enviar (máximo 500)

Saída

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.

Desarquivar stream de mensagens

POSTMARK_UNARCHIVE_MESSAGE_STREAM

Desarquiva um stream de mensagens anteriormente arquivado. Use quando precisar restaurar um stream arquivado (dentro de 45 dias após o arquivamento).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
stream_id	string	Sim	O ID do stream de mensagens a desarquivar. Deve ter sido arquivado nos últimos 45 dias.

Saída

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 stream de mensagens

POSTMARK_UPDATE_MESSAGE_STREAM

Atualiza a configuração de um stream de mensagens no Postmark. Use quando precisar modificar o nome ou a descrição de um stream. O tipo e o ID do stream não podem ser alterados após a criação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Name	string	Não	O nome do stream de mensagens
stream_ID	string	Sim	O ID do stream de mensagens a atualizar
Description	string	Não	A descrição do stream de mensagens

Saída

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.

Validar template

POSTMARK_VALIDATE_TEMPLATE

Valida um template Postmark. Use quando quiser verificar se o assunto e o corpo de um template são renderizados corretamente com dados de exemplo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
Subject	string	Não	A linha de assunto do template.
HtmlBody	string	Não	O conteúdo HTML do template.
TextBody	string	Não	O conteúdo em texto simples do template.
TemplateType	string	Sim	Tipo do template: Standard ou Layout.
TestRenderModel	object	Sim	Dados de mock usados para renderizar e validar o template.

Saída

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.