notifications

PUT `/v1/outbound-mail`

Attach or replace this organisation's own mail service.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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> }'

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`org_id (query)`	`string`	Ne	The organization to act on. Omitted (or empty) means your own.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`provider`	`string<smtp, mailgun, sendgrid, postmark, ses, resend>`	Da	`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_domain`	`string`	Da	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 `no…
`credential`	`string`	Da	The API key, server token or SMTP password. Never returned.
`config`	`object`	Ne	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…

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`can_configure`	`boolean`	Da	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 authorisat…
`account`	`OutboundMailAccount`	Da	null when this organisation sends on the platform's account.
`providers`	`object[]`	Da	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 c…
`sending_as`	`string<own, platform>`	Da	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`	Da	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`	Da	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…