mail

POST /v1/mail/services/{mailServiceId}/mailboxes

Create a mailbox.

Tous les points de terminaison mail

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation mail.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/mailboxes \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "local": <string> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Creates `local@domain` and returns it **with its password, once**. The password is never stored and cannot be read back — a lost one is replaced by `resetMailboxPassword`, not recovered. `password` is `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password; show that as "we could not display a password", never as a blank one. Requires `mail.manage`. Fails `409` on a duplicate address, and `422` when the service is not live yet or the domain is at its mailbox ceiling.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
mailServiceId (path)UuidOuiEmail service ID (UUIDv7).

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
localstringOuiThe part before the `@`.
sendbooleanNon
receivebooleanNon

Réponse

NomTypeObligatoireQu'est-ce que c'est
mailboxMailboxOuiOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectOuiThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 409 · 422 · 429 · 503