API reference

ट्रांज़ैक्शनल ईमेल REST API

API प्रमाणित अनुरोध स्वीकार करता है, प्रोजेक्ट scope और डोमेन की स्थिति सत्यापित करता है, suppression जाँचता है, फिर स्वीकृत संदेशों को कतार में डालता है।

24 जुलाई 2026 को अपडेट किया गयाOpenAPI 3.1 डाउनलोड करें

प्रमाणीकरण

POST /v1/emails

अनुरोध / प्रतिक्रिया

curl --request POST 'https://api.srs-postline.com/v1/emails' \
  --header 'Authorization: Bearer srs_live_...' \
  --header 'Idempotency-Key: order_4821' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "from": "Postline <info@example.com>",
    "to": ["user@example.net"],
    "subject": "Your order is ready",
    "html": "<p>Order #4821 is ready.</p>",
    "text": "Order #4821 is ready."
  }'

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "msg_01JPOSTLINEEXAMPLE",
  "status": "queued",
  "created_at": "2026-08-22T12:00:00Z"
}

इनपुट पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण	उदाहरण
`Authorization`	`header · string`	हाँ	Bearer टोकन के रूप में डैशबोर्ड से जारी scoped API कुंजी।	`Bearer srs_live_…`
`Idempotency-Key`	`header · string`	नहीं	एक तार्किक प्रेषण के लिए स्थिर पहचानकर्ता; इसकी दृढ़ अनुशंसा की जाती है।	`order_4821`
`from`	`string`	हाँ	सत्यापित डोमेन पर प्रेषक का नाम और पता।	`Postline <info@example.com>`
`to`	`string[]`	हाँ	एक से 100 प्राप्तकर्ता ईमेल पते।	`["user@example.net"]`
`subject`	`string`	हाँ	संदेश का विषय।	`आपका ऑर्डर तैयार है`
`html`	`string`	नहीं	HTML बॉडी। html या text में से एक आवश्यक है।	`<p>…</p>`
`text`	`string`	नहीं	सादा-पाठ बॉडी। text या html में से एक आवश्यक है।	`ऑर्डर #4821…`

प्रतिक्रिया कोड

स्थिति	HTTP	विवरण
`202`	Accepted	संदेश कतार में है; इसका अर्थ इनबॉक्स में डिलीवरी नहीं है।
`400`	Bad Request	अमान्य JSON या असमर्थित फ़ील्ड।
`401`	Unauthorized	API कुंजी अमान्य, समाप्त या निरस्त है।
`403`	Forbidden	scope अनुपलब्ध है या प्रेषक डोमेन सत्यापित नहीं है।
`422`	Unprocessable Entity	प्राप्तकर्ता suppression सूची में है।
`429`	Too Many Requests	प्रोजेक्ट की अनुरोध सीमा पार हो गई।

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

एक ईमेल भेजें

POST /v1/emails
Authorization: Bearer srs_live_…
Idempotency-Key: reset-4821
Content-Type: application/json

मुख्य संसाधन

POST/v1/emailsएक संदेश कतार में डालें

GET/v1/emails/{id}संदेश की स्थिति देखें

POST/v1/domainsएक भेजने वाला डोमेन जोड़ें

POST/v1/domains/{id}/verifyDNS जाँच चलाएं

GET/POST/DELETE/v1/suppressionssuppressed प्राप्तकर्ताओं को प्रबंधित करें

GET/POST/DELETE/v1/webhooksइवेंट एंडपॉइंट प्रबंधित करें

प्रतिक्रिया मॉडल

202 का अर्थ है कतार में डाला गया, इनबॉक्स में नहीं। 403 अनुपस्थित scope या असत्यापित डोमेन को इंगित कर सकता है। 422 suppressed प्राप्तकर्ता को ब्लॉक करता है। 429 rate limiting को इंगित करता है।

वर्तमान access model

वर्तमान keys srs_live_ उपयोग करती हैं। From domain verify होने से पहले shared sandbox sender केवल project members को भेज सकता है। उसके बाद plan quota, suppression, recipient throttling और abuse controls लागू रहते हैं। 202 का अर्थ queued है, delivered नहीं।

इंटीग्रेशन संसाधन

मनुष्यों और AI agents के लिए step-by-step guide उपयोग करें; fields के लिए OpenAPI source of truth है।