mail

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

Create a mailbox.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास mail.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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