मुख्य सामग्री पर जाएं
POST
cURL
सरल प्रश्नावलियाँ API के ज़रिए बनाने के लिए इस endpoint का उपयोग करें। form_elements एरे उसी क्रम में भेजें जिस क्रम में उपयोगकर्ताओं को प्रश्नों के उत्तर देने हैं। Didit आपके लिए आंतरिक प्रश्नावली ग्राफ़ बनाता है। API केवल सीधी रैखिक प्रश्नावलियों को सपोर्ट करता है। graph, branches, next या शर्तीय नियम न भेजें।

आवश्यक फ़ील्ड

  • title प्रश्नावली का आंतरिक नाम है।
  • languages में en शामिल होना चाहिए।
  • form_elements में कम से कम एक प्रश्न होना चाहिए।
  • हर फ़ॉर्म एलिमेंट में element_type और एक अनुवादित label होना चाहिए।
किसी भी फ़ॉर्म एलिमेंट में वैकल्पिक रूप से एक अनुवादित description जोड़ा जा सकता है, जो उसके सहायता टेक्स्ट के रूप में काम करता है। यह separator को छोड़कर हर एलिमेंट प्रकार पर स्वीकार किया जाता है, और प्रश्नावली रिपोर्ट में उस आइटम के description के रूप में लौटाया जाता है।

एलिमेंट के प्रकार

short_text, multiple_choice, email, file_upload या date_picker जैसे लोअरकेस मान उपयोग करें। SHORT_TEXT जैसे अपरकेस एनम मान भी स्वीकार किए जाते हैं। dropdown, single_choice और multiple_choice के लिए options जोड़ें। अगर आप विकल्प का value छोड़ देते हैं, तो Didit लेबल से एक मान बना देता है।

फ़ील्ड सत्यापन

उपयोगकर्ता के उत्तर पर एक फ़ॉर्मेट लागू करने के लिए short_text, long_text या number एलिमेंट में वैकल्पिक validation ऑब्जेक्ट जोड़ें। यह कर पहचान संख्या, राष्ट्रीय पहचान संख्या या कार्ड नंबर जैसे सख़्त फ़ॉर्मेट वाले पहचानकर्ताओं के लिए उपयोगी है। सत्यापन तब चलता है जब उपयोगकर्ता फ़ील्ड भर रहा होता है (जब तक मान पास न हो, उपयोगकर्ता आगे नहीं बढ़ सकता), और सबमिशन पर API इसे दोबारा लागू करता है।
रिस्पॉन्स में questionnaire_id शामिल होता है। इसे सहेज कर रखें, क्योंकि प्रश्नावली को वर्कफ़्लो में जोड़ते समय इसे questionnaire_uuid के रूप में उपयोग करेंगे।

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json

एक सरल रैखिक प्रश्नावली बनाएँ। API form_elements को आंतरिक प्रश्नावली ग्राफ़ में बदल देता है।

title
string
आवश्यक

प्रश्नावली के लिए आंतरिक नाम।

languages
string[]
आवश्यक

प्रत्येक लेबल में शामिल भाषाएँ। इसमें en शामिल होना चाहिए।

उदाहरण:
form_elements
object[]
आवश्यक

प्रश्न उसी सटीक क्रम में होने चाहिए जिस क्रम में उपयोगकर्ताओं को उन्हें देखना चाहिए। ब्रांचिंग और सशर्त फ़ील्ड समर्थित नहीं हैं।

Minimum array length: 1
description
string | null
default_language
string

डिफ़ॉल्ट भाषा। languages में शामिल होनी चाहिए।

उदाहरण:

"en"

is_active
boolean
डिफ़ॉल्ट:true
status
enum<string>

वर्कफ़्लो के लिए तैयार एक प्रकाशित प्रश्नावली बनाने के लिए इस फ़ील्ड को छोड़ दें।

उपलब्ध विकल्प:
draft,
published

प्रतिक्रिया

प्रश्नावली बनाई गई। रिस्पॉन्स में questionnaire_id शामिल है — वर्कफ़्लो या भविष्य के अपडेट/डिलीट कॉल से इस प्रश्नावली को संदर्भित करने के लिए इसे संग्रहीत करें।

GET, POST (बनाएँ) और PATCH (अपडेट करें) endpoint से लौटाया गया पूर्ण प्रश्नावली विवरण।

questionnaire_id
string<uuid>

प्रश्नावली का विशिष्ट पहचानकर्ता। वर्कफ़्लो से या बाद के अपडेट/डिलीट अनुरोधों में प्रश्नावली का संदर्भ देते समय इस id का उपयोग करें।

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

start_node और nodes मैप के साथ ग्राफ़ संरचना।

sections
object[]

अनुभागों में समूहीकृत प्रश्नावली सामग्री (ग्राफ़ से प्राप्त)।

questionnaire_group_id
string<uuid>

स्थिर पहचानकर्ता जो एक ही प्रश्नावली के सभी संस्करणों को समूहित करता है।

version
integer
status
enum<string>
उपलब्ध विकल्प:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True जब प्रश्नावली को अभी भी उसी स्थान पर संपादित किया जा सकता है (ड्राफ़्ट संस्करण)।

अंतिम संशोधन 7 नवंबर 2026