GET /v1/mail/mailboxes/{mailboxId}/client-setup

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/mail/mailboxes/{mailboxId}/client-setup \
  -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

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.

Parameters

Response

Errors this endpoint can return

401 · 403 · 404 · 422 · 429