Skip to Content
API संदर्भसबमिशन

सबमिशन

सबमिशन आपके प्रोजेक्ट की बग रिपोर्ट और सुविधा अनुरोध हैं — वही पोस्ट जो आपके उपयोगकर्ता पोर्टल पर बनाते हैं, API के माध्यम से पढ़ने और लिखने के लिए उपलब्ध। (सामान्य फ़ीडबैक का अपना एंडपॉइंट है; देखें फ़ीडबैक।)

सभी एंडपॉइंट के लिए प्रमाणीकरण आवश्यक है और वे API कुंजी के प्रोजेक्ट तक सीमित हैं।

सबमिशन सूचीबद्ध करना

GET/v1/submissions

ParameterTypeDescription
statusstringस्थिति से फ़िल्टर करें: backlog, open, planned, in_progress या done।
typestringप्रकार से फ़िल्टर करें: bug या feature।
limitintegerपृष्ठ का आकार। डिफ़ॉल्ट 20।
offsetintegerछोड़ी जाने वाली वस्तुओं की संख्या। डिफ़ॉल्ट 0।
curl "https://api.supdesk.app/v1/submissions?status=open&limit=10" \ -H "Authorization: Bearer sd_live_..."

प्रतिक्रियाएँ मानक सूची आवरण का उपयोग करती हैं:

{ "data": [ { "id": "8f7a…", "type": "bug", "title": "Export button unresponsive on Safari", "body": "Clicking Export does nothing on Safari 26.", "status": "open", "is_private": false, "created_at": "2026-07-01T09:12:00Z" } ], "pagination": { "limit": 10, "offset": 0, "has_more": false } }

एक सबमिशन प्राप्त करना

GET/v1/submissions/:id

{ "data": { … } } के रूप में एक सबमिशन लौटाता है, या 404 not_found त्रुटि।

सबमिशन बनाना

Pro लेखन पहुँच के लिए सशुल्क योजना आवश्यक है; Free पर यह 403 forbidden लौटाता है।

POST/v1/submissions

ParameterTypeDescription
typerequiredstringbug या feature।
titlerequiredstringसबमिशन का संक्षिप्त सारांश।
emailrequiredstringउस अंतिम उपयोगकर्ता का ईमेल जिसका यह सबमिशन है।
bodystringलंबा विवरण।
namestringअंतिम उपयोगकर्ता के लिए प्रदर्शन नाम।
localestringइससे ट्रिगर होने वाले सूचना ईमेल की भाषा (en, ar, de, es, fr, he, hi, it, ja, ru, zh)। डिफ़ॉल्ट en।
curl -X POST https://api.supdesk.app/v1/submissions \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "type": "bug", "title": "Export button unresponsive on Safari", "email": "jamie@example.com", "body": "Clicking Export does nothing on Safari 26." }'

बनाए गए सबमिशन के साथ 201 लौटाता है। अंतिम उपयोगकर्ता आपके प्रोजेक्ट की ग्राहक सूची में अपने आप बन जाता है (या ईमेल से मिलान हो जाता है)।

बनाए गए सबमिशन आपके मासिक सबमिशन कोटे में ठीक पोर्टल सबमिशन की तरह गिने जाते हैं। सीमा पर, यह एंडपॉइंट 429 limit_reached लौटाता है — जब तक कि आपके वर्कस्पेस में सबमिशन ओवरेज सक्षम न हो, ऐसी स्थिति में सबमिशन स्वीकार किया जाता है और बिल किया जाता है। देखें दर सीमाएँ और उपयोग

Last updated on