GET /v1/sites/{siteId}/mail-smtp
Get the site's own SMTP server for website mail.
Authentication
Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-smtp \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
By default a site's website mail (WordPress wp_mail(), PHP mail(), contact forms, WooCommerce receipts) leaves through our mail relay as the site. A customer may instead send it through their OWN SMTP server (Google Workspace, Microsoft 365, their host). Returns configured: false when none is saved. The password is never returned. status: unverified (saved, not proven yet), active (proven from the site's server and in use), failing (the site's server could not log in; the site keeps sending through our relay meanwhile). last_error is a code — auth, tls, unreachable, unsupported, password_unreadable, server. Requires mail.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
configured | boolean | Yes | — |
host | string | No | — |
port | integer<25, 465, 587, 2525> | No | — |
tls | string<starttls, implicit> | No | — |
username | string | No | — |
from_address | string | No | — |
enabled | boolean | No | — |
status | string<unverified, active, failing> | No | — |
last_error | string | No | A code: auth, tls, unreachable, unsupported, password_unreadable, server, or empty. |
proven_at | string | No | — |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 429