notifications

POST /v1/outbound-mail/test

Send a real message through your provider, carrying a one-time code.

Todos os endpoints de notifications

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/outbound-mail/test \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "to": <string> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Sends an actual email through the attached service to an address you nominate. It contains a code; enter that code at `/v1/outbound-mail/verify` to switch the account on. The send happens before anything is stored. If your provider refuses the message the account stays exactly where it was and the error says what the provider said - a tenant with a wrong key must be told the key is wrong, not left waiting for a message that was never sent.

Parâmetros

NomeTipoObrigatórioO que é
org_id (query)stringNãoThe organization to act on. Omitted means your own.

Corpo da requisição

NomeTipoObrigatórioO que é
tostringSimAn inbox you can read. Use one OUTSIDE the domain you are configuring where you can: a message that never leaves your own server proves less than one that crossed the internet.

Resposta

NomeTipoObrigatórioO que é
can_configurebooleanSimWhether this organisation's plan includes its own sending identity - the agency and reseller plans do, a plain client plan does not. A claim about the PLAN, never the authorisat…
accountOutboundMailAccountSimnull when this organisation sends on the platform's account.
providersobject[]SimThe provider catalogue AND the fields each one needs, served from the same definition the API validates against - so the form a customer fills in and the rules it must satisfy c…
sending_asstring<own, platform>SimWho is actually paying for this organisation's mail right now. `platform` whenever no account is attached OR the attached one has not completed its round trip.
fallback_noticestringSimPlain-language explanation shown when `sending_as` is `platform`; empty otherwise. Part of the contract rather than presentation - an empty state that does not say who is paying…
client_orgs_heldintegerSimHow many client organisations under this one currently have their non-essential notifications held because no own mail provider is connected (owner ruling 2026-09-03). `0` when…