mail

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

Create a mailbox.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`mailServiceId (path)`	`Uuid`	כן	Email service ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`local`	`string`	כן	The part before the `@`.
`send`	`boolean`	לא	—
`receive`	`boolean`	לא	—

תשובה

שם	סוג	נדרש	מה זה
`mailbox`	`Mailbox`	כן	One mailbox. Never carries a password — see `MailboxCreated`.
`password`	`object`	כן	The password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

שגיאות שנקודה קצה זו עשויה להחזיר

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

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