GET /v1/mail/mailboxes/{mailboxId}/apple-profile
An Apple configuration profile for this mailbox.
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}/apple-profile \
-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
A .mobileconfig that sets the mailbox up on iOS or macOS in one tap. It carries the hostnames, ports and username; no password is in it — the person types their own when the profile installs, so the file is safe to download, e-mail to yourself or keep. 404 when the mailbox is on Google Workspace or Microsoft 365, whose own profiles configure calendars and contacts as well and are the better answer. Requires mail.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailboxId (path) | Uuid | Yes | Mailbox ID (UUIDv7). |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429