डॉक्यूमेंटेशन
पैरामीटर्स
क्वेरी
custom_username
ईमेल पते के लिए वैकल्पिक कस्टम उपयोगकर्ता नाम। इसमें अक्षर, संख्याएं, डॉट्स, हाइफ़न और अंडरस्कोर हो सकते हैं। 3-30 वर्ण होने चाहिए। यदि छोड़ दिया गया है, तो एक यादृच्छिक उपयोगकर्ता नाम उत्पन्न किया जाएगा।
उदाहरण:
john.doe⚠️ ⚠️ 3-30 वर्ण होने चाहिए। विशेष वर्णों से शुरू/समाप्त नहीं हो सकता। अद्वितीय होना चाहिए। पहले से लिया गया होने पर 409 लौटाता है।
क्वेरी
time
समाप्ति समय
उदाहरण:
permanent⚠️ यह होना चाहिए: 10min, 1hour, 1day, permanent
क्वेरी
domain
ईमेल पते के लिए वैकल्पिक कस्टम डोमेन। आपके खाते में सत्यापित डोमेन होना चाहिए (सत्यापन के लिए custom_domains एंडपॉइंट का उपयोग करें)। यदि निर्दिष्ट नहीं किया गया है, तो एक यादृच्छिक सार्वजनिक डोमेन उपयोग किया जाएगा।
उदाहरण:
mail.yourdomain.com⚠️ ⚠️ सत्यापित कस्टम डोमेन या सार्वजनिक डोमेन होना चाहिए। उपलब्ध नहीं होने पर 400 लौटाता है।
क्वेरी
create_as_dashboard
💎 प्रीमियम सुविधा - समय-आधारित API ईमेल के बजाय 2 महीने की निश्चित समाप्ति के साथ डेटाबेस में संग्रहीत डैशबोर्ड-शैली ईमेल बनाने के लिए "true" पर सेट करें। समय-आधारित ईमेल के लिए छोड़ दें या "false" पर सेट करें (डिफ़ॉल्ट)। डैशबोर्ड ईमेल की लागत 15 क्रेडिट है। मुफ्त टियर उपयोगकर्ताओं को 403 त्रुटि मिलेगी।
उदाहरण:
true⚠️ ⚠️ "true" होना चाहिए या छोड़ दिया जाना चाहिए। डैशबोर्ड ईमेल के लिए बेसिक प्लान या उच्चतर की आवश्यकता है। 2 महीने की निश्चित समाप्ति (समय पैरामीटर को अनदेखा किया जाता है)।
त्रुटि उदाहरण
400
INVALID_USERNAME
उपयोगकर्ता नाम कम से कम 3 वर्ण होना चाहिए
कस्टम उपयोगकर्ता नाम सत्यापन विफल। केवल वैध वर्णों के साथ 3-30 वर्ण होने चाहिए।
409
EMAIL_IN_USE
ईमेल पता "[email protected]" पहले से उपयोग में है
कस्टम उपयोगकर्ता नाम पहले से लिया गया है। एक अलग उपयोगकर्ता नाम चुनें।
400
DOMAIN_NOT_FOUND
डोमेन "custom.domain" उपलब्ध नहीं है। यह आपके खाते में सत्यापित कस्टम डोमेन या सार्वजनिक डोमेन होना चाहिए।
निर्दिष्ट डोमेन मौजूद नहीं है या सत्यापित नहीं है। पहले इसे अपने खाते में सत्यापित करें।
400
DOMAIN_NOT_VERIFIED
कस्टम डोमेन "custom.domain" सत्यापित नहीं है। वर्तमान स्थिति: लंबित
डोमेन मौजूद है लेकिन अभी तक सत्यापित नहीं है। पहले डोमेन सत्यापन पूरा करें।
429
DAILY_LIMIT_EXCEEDED
1 घंटे के ईमेल के लिए दैनिक सीमा पार हो गई
आपने इस प्रकार के ईमेल के लिए अपनी दैनिक सीमा पहुंचा ली है
उदाहरण अनुरोध
curl -X POST "https://v1.boomlify.com/api/v1/emails/create"कोड स्निपेट्स
const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
}
});
const data = await response.json();