notifications

PUT /v1/outbound-mail

Attach or replace this organisation's own mail service.

Усі кінцеві точки notifications

Уся документація для розробників

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X PUT https://api.zinndigital.com/v1/outbound-mail \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "provider": <string<smtp, mailgun, sendgrid, postmark, ses, resend>>, "from_domain": <string>, "credential": <string> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

PUT rather than POST because a From header is singular: an organisation has exactly one sending service, and the commonest reason to be on this screen is switching provider. The credential is write-only. It goes straight to the secret vault and the row keeps only a pointer; it is never returned by any endpoint in any state. Attaching does NOT switch the sender. A new or replaced credential resets the account to unverified, and only a completed round trip - a real test message, and the code out of it - makes it the From address. A provider that accepts a message and then bounces it is indistinguishable from a working one at the moment of the call, so acceptance is not proof.

Параметри

НазваТипОбов'язковеЩо це таке
org_id (query)stringНіThe organization to act on. Omitted (or empty) means your own.

Тіло запиту

НазваТипОбов'язковеЩо це таке
providerstring<smtp, mailgun, sendgrid, postmark, ses, resend>Такses is Amazon SES over its documented SMTP interface, so the credential is an SES SMTP username and password rather than an AWS access key.
from_domainstringТакThe domain your From address will use - a domain, not an address. The local part still comes from the message type, so a receipt leaves as billing@ and a password reset as…
credentialstringТакThe API key, server token or SMTP password. Never returned.
configobjectНіThe non-secret settings this provider needs - SMTP host/port/username, Mailgun domain and region, the SES region, the Postmark message stream. The exact fields are returned per…

Відповідь

НазваТипОбов'язковеЩо це таке
can_configurebooleanТакWhether 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…
accountOutboundMailAccountТакnull when this organisation sends on the platform's account.
providersobject[]ТакThe 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…
sending_asstring<own, platform>ТакWho 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_noticestringТакPlain-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_heldintegerТакHow 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 a…