mail

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

Create a mailbox.

Všechny koncové body mail

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
mailServiceId (path)UuidAnoEmail service ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
localstringAnoThe part before the @.
sendbooleanNe
receivebooleanNe

Odpověď

NázevTypPožadovánoCo to je
mailboxMailboxAnoOne mailbox. Never carries a password — see MailboxCreated.
passwordobjectAnoThe password, shown once. null when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

Chyby, které může tento koncový bod vrátit

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