GET /v1/mail/mailboxes/{mailboxId}/client-setup
Everything needed to add this mailbox to a mail app.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу mail.view; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId}/client-setup \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The hostnames, ports, socket security and username for this mailbox, so a customer can set it up on a phone, in Outlook, in Apple Mail or in Thunderbird without asking us. One payload for every client — the per-client wording is translated copy on the surfaces that render it, not part of this contract. The username is the full address on both servers, stated rather than left to be derived: it is the single most common thing a person types wrongly. apple_profile_available and autodiscover_available say whether the two self-configuring routes exist for this mailbox — they do for Zinn®'s own email, and not for Google Workspace or Microsoft 365, whose own clients already know their provider. A zinn service under a white-label account is a 422: our hostnames must not reach a reseller's client (W40-MAIL). Requires mail.view.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
mailboxId (path) | Uuid | Да | Mailbox ID (UUIDv7). |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
address | string | Да | The mailbox address. |
domain | string | Да | — |
provider | MailProvider | Да | Which provider serves a domain's mail. custom is the reseller's own provider (W40-MAIL, owner ruling 2026-09-06): a white-label reseller sells mail they buy elsewhere,… |
username | string | Да | What to type in the username field — the full address, on both the incoming and the outgoing server. |
auth | string<password> | Да | How the customer proves who they are. password means the mailbox's own password, sent inside the TLS session security establishes. |
incoming | MailClientServer | Да | One server a mail client connects to. |
outgoing | MailClientServer | Да | One server a mail client connects to. |
apple_profile_available | boolean | Да | Whether /v1/mail/mailboxes/{mailboxId}/apple-profile will serve a profile for this mailbox. |
autodiscover_available | boolean | Да | Whether Outlook and Thunderbird can configure themselves from the address alone for this domain. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429