API संदर्भ

ईमेल भेजें

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

अवलोकन

एंडपॉइंटhttps://api.unbox.im/v1/email
विधिPOST
Content-Typeapplication/json
दायराप्रति कस्टम डोमेन एक API कुंजी

अकाउंट → डोमेन → आपका डोमेन → API में DNS सत्यापन पूरा होने के बाद कुंजियाँ जनरेट करें। पूर्ण सीक्रेट केवल एक बार दिखाया जाता है — इसे सुरक्षित रखें। उसी डोमेन पैनल में वैकल्पिक SMTP क्रेडेंशियल्स समान केवल-लेन-देन नियमों का पालन करते हैं।

केवल लेन-देन संबंधी मेल

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

अनुमत उपयोग

  • खाता सत्यापन, पासवर्ड रीसेट और सुरक्षा अलर्ट
  • ऑर्डर पुष्टिकरण, रसीदें, शिपिंग अपडेट और भुगतान सूचनाएँ
  • किसी विशिष्ट उपयोगकर्ता या सिस्टम घटना द्वारा ट्रिगर की गई सूचनाएँ
  • टीम और वर्कस्पेस संदेश (आमंत्रण, असाइनमेंट, आंतरिक अलर्ट)

निषिद्ध उपयोग

  • न्यूज़लेटर, प्रचार अभियान या प्रसारण विपणन
  • कोल्ड आउटरीच या खरीदी गई, स्क्रैप की गई या सहमति न देने वाली सूचियों पर मेल
  • एफिलिएट स्पैम, फ़िशिंग या भ्रामक सामग्री
  • प्राप्तकर्ता सीमा, दर सीमा या योजना कोटा को बायपास करने का कोई भी प्रयास

दर और प्राप्तकर्ता सीमाएँ

प्राप्तकर्ताओं और डिलीवरेबिलिटी की सुरक्षा के लिए, आउटबाउंड API और SMTP ट्रैफ़िक नीचे दी गई सीमाओं के अधीन है (आपकी योजना की मासिक आउटबाउंड कोटा के अतिरिक्त)। प्रवर्तन वेब कंपोज़र, HTTP API और SMTP सबमिशन पर सक्रिय है। वेब कंपोज़र प्रति संदेश 25 प्राप्तकर्ताओं के बाद चेतावनी देता है और 50 से अधिक भेजने को रोकता है।

सीमामान
प्रति संदेश प्राप्तकर्ताकुल 50 तक (To + Cc + Bcc संयुक्त)
प्रति दिन अद्वितीय प्राप्तकर्ताप्रति वर्कस्पेस 1,000 तक
अनुरोध भेजने की दरप्रति डोमेन प्रति मिनट 10 API या SMTP सबमिशन तक
योजना आउटबाउंड कोटाआपकी सदस्यता पर मासिक भेजने की सीमाएँ अभी भी लागू हैं

ये नियम हमारी स्वीकार्य उपयोग नीति का हिस्सा हैं। स्वचालित प्रवर्तन वेब कंपोज़र, HTTP API और SMTP सबमिशन पर सक्रिय है। जो खाते विपणन या बल्क मेल भेजते हैं, या अन्यथा भेजने के बुनियादी ढांचे का दुरुपयोग करते हैं, उन्हें थ्रॉटल, निलंबित या समाप्त किया जा सकता है।

हम डिलीवरेबिलिटी सिग्नल की निगरानी करते हैं। 3% से अधिक लगातार बाउंस दर या 0.1% से अधिक शिकायत दर अस्थायी भेजने पर रोक या मैन्युअल समीक्षा को ट्रिगर कर सकती है।

पूर्ण नीति विवरण के लिए हमारा सेवा की शर्तें, गोपनीयता नीति और GDPR वक्तव्य देखें।

प्रमाणीकरण

हर अनुरोध पर अपनी डोमेन API कुंजी भेजें:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

वैकल्पिक रूप से, X-Api-Key: ubk_live_… का उपयोग करें। कुंजियाँ हैश करके संग्रहीत की जाती हैं; डोमेन डैशबोर्ड से रिवोक या रोटेट करें।

अनुरोध बॉडी

PascalCase फ़ील्ड नामों (From, To, …) के साथ JSON। camelCase उपनाम भी स्वीकार किए जाते हैं।

फ़ील्डआवश्यकविवरण
Fromहाँप्रेषक — कुंजी के डोमेन पर आपका व्यक्तिगत मेलबॉक्स (प्राथमिक या उपनाम)। साझा कतारें मान्य प्रेषक नहीं हैं।
Toहाँप्राप्तकर्ता — स्ट्रिंग, अल्पविराम से अलग की गई स्ट्रिंग, या ऐरे
Subjectहाँविषय पंक्ति
TextBodyTextBody / HtmlBody में से एकसादा टेक्स्ट बॉडी
HtmlBodyTextBody / HtmlBody में से एकHTML बॉडी
Ccनहींप्रति प्राप्तकर्ता
Bccनहींअंध प्रति प्राप्तकर्ता
ReplyToनहींउत्तर-पता
Tagनहींवैकल्पिक मेटाडेटा टैग (भेजने के साथ संग्रहीत)

उदाहरण

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

सफलता प्रतिक्रिया

HTTP 200 JSON के साथ:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

त्रुटि प्रतिक्रियाएँ

त्रुटियाँ 4xx (या अप्रत्याशित विफलताओं के लिए 500) JSON के साथ लौटाती हैं:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
त्रुटि कोडअर्थ
0सफलता
10API कुंजी गायब है
11अमान्य या रद्द की गई कुंजी, या भेजने के लिए डोमेन सत्यापित नहीं है
300मान्यता त्रुटि (लापता फ़ील्ड, अमान्य JSON, आदि)
403प्रेषक पता अनुमति नहीं — कुंजी के डोमेन पर आपका व्यक्तिगत मेलबॉक्स होना चाहिए
406SES ने संदेश अस्वीकार कर दिया

उदाहरण

you@yourdomain.com को डोमेन पर अपने व्यक्तिगत मेलबॉक्स से बदलें और अपनी API कुंजी का उपयोग करें।

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

आरंभ करना

  1. Unbox खाता बनाएँ और अपना कस्टम डोमेन जोड़ें।
  2. डोमेन में सभी DNS सत्यापन चरण पूरे करें।
  3. डोमेन → आपका डोमेन → API खोलें और एक डोमेन कुंजी जनरेट करें।
  4. ऊपर दिए गए उदाहरणों के साथ अपना पहला संदेश भेजें।
Unbox — API दस्तावेज़ | Unbox.im