mail

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

Create a mailbox.

Todos os endpoints de mail

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

NomeTipoObrigatórioO que é
mailServiceId (path)UuidSimEmail service ID (UUIDv7).

Corpo da requisição

NomeTipoObrigatórioO que é
localstringSimThe part before the `@`.
sendbooleanNão
receivebooleanNão

Resposta

NomeTipoObrigatórioO que é
mailboxMailboxSimOne mailbox. Never carries a password — see `MailboxCreated`.
passwordobjectSimThe password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Erros que este endpoint pode retornar

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