मुख्य सामग्री पर जाएं
PATCH
cURL
आंशिक अपडेट के लिए PATCH का उपयोग करें। प्रश्नावली का नाम बदलने के लिए केवल title या description भेजें।
प्रश्न अपडेट करने के लिए पूरा वांछित form_elements array भेजें। यह पिछली प्रश्न सूची की जगह ले लेता है। जो मौजूदा प्रश्न आप अब भी दिखाना चाहते हैं, उन्हें शामिल रखें।
v3 API केवल सरल रैखिक प्रश्नावलियों का समर्थन करता है। यह graph, branches, next और शर्तीय नियमों को अस्वीकार करता है। रिस्पॉन्स में questionnaire_id शामिल होता है। जब आप published प्रश्नावली अपडेट करते हैं, तो API नया संस्करण बना सकता है। लौटाए गए questionnaire_id को सहेजें और वर्कफ़्लो में उसी का उपयोग करें, यह मानकर न चलें कि URL में दिया गया id अब भी सबसे नया संस्करण है।

प्राधिकरण

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।

पथ पैरामीटर

questionnaire_uuid
string<uuid>
आवश्यक

अपडेट करने के लिए प्रश्नावली का प्रति-संस्करण UUID।

बॉडी

application/json

प्रश्नावली मेटाडेटा अपडेट करें या पूरी लीनियर form_elements सूची को बदलें।

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
status
enum<string>
उपलब्ध विकल्प:
draft,
published
form_elements
object[]

यदि प्रदान किया जाता है, तो यह पूरी लीनियर प्रश्न सूची को बदल देता है।

Minimum array length: 1

प्रतिक्रिया

प्रश्नावली अपडेट की गई। body परिणामी संस्करण की नवीनतम स्थिति है — इन-प्लेस अपडेट किया गया संस्करण, या नया बनाया गया प्रकाशित संस्करण जब आपने प्रकाशित पंक्ति पर status: "published" भेजा था (उस स्थिति में questionnaire_id और version आपके द्वारा पैच किए गए संस्करणों से भिन्न होते हैं)। रिस्पॉन्स में questionnaire_id प्रति-संस्करण UUID है; यदि आपको स्थिर समूह पहचानकर्ता की आवश्यकता है तो questionnaire_group_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