notifications
POST /v1/outbound-mail/test
Send a real message through your provider, carrying a one-time code.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/outbound-mail/test \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "to": <string> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
org_id (query) | string | Не | The organization to act on. Omitted means your own. |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
to | string | Да | An 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. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
can_configure | boolean | Да | 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… |
account | OutboundMailAccount | Да | null when this organisation sends on the platform's account. |
providers | object[] | Да | 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_as | string<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_notice | string | Да | 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_held | integer | Да | 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… |