mail

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

Create a mailbox.

Todos los endpoints de mail

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso mail.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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> }'

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

NombreTipoObligatorio¿Qué es esto?
mailServiceId (path)UuidEmail service ID (UUIDv7).

Cuerpo de la solicitud

NombreTipoObligatorio¿Qué es esto?
localstringThe part before the `@`.
sendbooleanNo
receivebooleanNo

Respuesta

NombreTipoObligatorio¿Qué es esto?
mailboxMailboxOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Errores que este endpoint puede devolver

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