{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"CFM Survey Response APIs V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"cfm-survey-response-apis-v3--developer-guide","__idx":0},"children":["CFM Survey Response APIs V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Customer Feedback Management (CFM) Survey Response APIs V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/cfm-survey-response-apis"},"children":["CFM Survey Response APIs | Sprinklr Developer Portal"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/fetch-survey-response"},"children":["Fetch Survey Response (V2)"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["survey response"]}," is a single completed submission against a Sprinklr CFM survey. It records what the respondent answered, who they were, how and when they answered, and any custom metadata attached to the response, the responder's profile, or the transaction that triggered the survey."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The CFM Survey Response APIs let you move response data programmatically in both directions. Per the Sprinklr Help Center: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"You can leverage the Standard CRUD APIs for survey responses to programmatically create, retrieve, update, or delete response data within the Sprinklr system. This capability facilitates seamless integration with external systems and supports automated workflows.\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Five operations are exposed across ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["two paths"]}," — four methods on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse"]},", plus a dedicated search path:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"operationId"},"children":["operationId"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import (ingest) a survey response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseApiV3_ingestSurveyResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch survey response(s) by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseApiV3_fetchSurveyResponses"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search survey responses"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse/search?surveyId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseApiV3_searchSurveyResponses"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update response custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseApiV3_updateSurveyResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete survey response(s) by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseApiV3_deleteSurveyResponses"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This single-path, method-differentiated shape is the central design change in V3, and it matches the pattern already used by Profile V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/profile"]},") and Survey Transactions V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyTransactions"]},"). V2 spread the same capabilities across separately-named paths such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/survey-response/{survey-response-id}"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-survey-response-data-model","__idx":2},"children":["1.1 The survey response data model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response data is modeled in three layers. Understanding this model is the fastest way to understand every endpoint in this guide."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Layer"},"children":["Layer"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Object"},"children":["Object"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it holds"},"children":["What it holds"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity and context"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyLanguage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyMode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyResponseType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distributionEntityId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyStartTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyOpenTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Which survey, which response, when, in what mode and language"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Responder and device"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browser"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserVersion"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatingSystem"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseQuality"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who answered, on what, and how trustworthy the answer is judged to be"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Answers and metadata"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The answers themselves, plus three separate namespaces of custom metadata"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The three custom-metadata namespaces are the part most developers get wrong:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Namespace"},"children":["Namespace"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Configured in"},"children":["Configured in"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specific to this one response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Global Settings → Response Custom Fields"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attached to the responder's audience profile"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile custom field configuration"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attached to the CFM transaction that triggered the survey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Global Settings → Transaction Fields"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-addressing-a-survey-response","__idx":3},"children":["1.2 Addressing a survey response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A response is addressed by its ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}]}," — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a8c451269baf80612fb6417"]}," — passed as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," query parameter."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}," describes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," as a ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Comma-separated list of survey response ids\""]},", so both operations are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["bulk-capable"]},". On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," the description is singular: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Survey response id.\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To find a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," in the Sprinklr UI:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer Feedback Management (CFM)"]}," persona app in Sprinklr."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Programs"]}," tab, locate the survey whose responses you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hover over the survey. A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]}," button is displayed. Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the top bar, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Responses"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Id"]}," column values are the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To find a custom field's internal name:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the CFM persona app and navigate to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Programs"]}," tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hover over the survey and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["From the top navigation bar, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Scroll to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Survey Custom Fields"]},". It contains ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transaction Fields"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Custom Fields"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View Fields"]}," next to the category you need."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Find the field, click the three-dot menu (⋮), and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy Field Name"]}," to copy the internal field ID used in API requests."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Internal field names follow the pattern ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_<24-hex-id>"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_67cb50793cae6f06c0c41de0"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"13-prerequisites","__idx":4},"children":["1.3 Prerequisites"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CFM must be enabled in your environment."]}," Per the Developer Portal: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"CFM must be enabled in your environment before you can utilize these APIs. Please contact your Success Manager for more details.\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions."]}," Per the Help Center: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"You would need ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View and Edit Response and Analytics permissions at the Survey Level"]},".\""]}," The API user must be able to access the survey's analytics in the UI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["You must know the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}]}," for the survey you are integrating with, and the specific ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," values for read, update, and delete operations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request a sample payload from Sprinklr Support."]}," All five supplied endpoint specifications carry the same Dev Note: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"To use this API, you will need values for the parameters mentioned below. To obtain these values, reach out to Sprinklr Support at tickets@sprinklr.com.\""]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":5},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All API calls are sent to the production endpoint:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the survey response resource in production is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/surveyResponse\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod3"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod4"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod5"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod6"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod8"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod12"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod15"]},"–",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod19"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod21"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod24"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["production"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr-uat"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["azrqa"]}," — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the authoritative list)."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":6},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All CFM Survey Response API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorize flow."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server. For generating the authorization token, see the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorize"]}," section on the developer portal."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the application with the server. For generating an API key, see the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting Started"]}," guide."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the request body media type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the acceptable response type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-import-a-survey-response","__idx":7},"children":["4. Import a survey response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Imports a survey response from any external source — a CRM, an internal application, or an offline data-collection tool — into Sprinklr CFM."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/surveyResponse\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseIngestionRequest"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Survey Response Ingestion Request\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-request-body","__idx":8},"children":["4.1 Request body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the survey for which the response is being submitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains the responses provided for survey questions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<QUESTION_ID>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maps a survey question ID to one or more response values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp in milliseconds since Unix epoch, representing when the survey response was submitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the survey response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distributionChannel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Channel through which the survey response was collected. For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXTERNAL_APPLICATION"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields associated with the survey response. Values are arrays of strings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields associated with the responder's profile. Values are arrays of strings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields associated with the survey transaction. Values are arrays of strings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the responder in the source system. Can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if not available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of source network associated with the responder. Can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if not available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyLanguage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language in which the survey response was submitted. Can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if not specified."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elapsedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time taken by the responder to complete the survey, in milliseconds. Can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if not available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consolidated object containing all custom fields associated with the response, profile, and transaction."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}," declares no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseIngestionRequest"]},", so no field is formally mandatory. In practice ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]}," are the minimum meaningful payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-example-request","__idx":9},"children":["4.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"surveyId\": \"6a840fb9a64a419291aacd53\",\n    \"questionResponses\": {\n      \"422131e5-67e9-4e7d-8edf-448c7e455f0e\": [\"Neutral\"]\n    },\n    \"responseTime\": 1738281600000,\n    \"tags\": [\"tag1\"],\n    \"distributionChannel\": \"EXTERNAL_APPLICATION\",\n    \"responseCustomFields\": {\n      \"_c_67cb50793cae6f06c0c41de0\": [\"5\"]\n    },\n    \"profileCustomFields\": {\n      \"_c_64cbf526fd8b0e259d72470a\": [\"20\"]\n    },\n    \"transactionCustomFields\": {\n      \"_c_67056c1056182e36198d8eea\": [\"WHATSAPP\"]\n    },\n    \"responderSnId\": null,\n    \"responderSnType\": null,\n    \"surveyLanguage\": null,\n    \"elapsedTime\": null\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-example-response","__idx":10},"children":["4.3 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"responseId\": \"6a8c451269baf80612fb6417\"\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-response-parameters","__idx":11},"children":["4.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains details of the created survey response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the survey response created successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains details of any errors encountered while processing the request. Returns an empty array when the request is successful."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Persist ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responseId"]}," — it is the only handle for later fetch, update, or delete."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-fetch-survey-responses","__idx":12},"children":["5. Fetch survey response(s)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves detailed information about a specific survey response using its unique ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v3/surveyResponse?id={responseId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response schema (per ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},"):"]}," array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseDTO"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-request-parameters","__idx":13},"children":["5.1 Request parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (spec)"},"children":["Required (spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required: false"]}," in the OpenAPI specification; ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}," in the supplied endpoint specification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of survey response IDs to retrieve."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-example-request","__idx":14},"children":["5.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse?id=6a8c451269baf80612fb6417' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-example-response","__idx":15},"children":["5.3 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"hasMore\": false,\n      \"responses\": [\n        {\n          \"surveyId\": \"6a840fb9a64a419291aacd53\",\n          \"responseId\": \"6a8c451269baf80612fb6417\",\n          \"responseStatus\": \"COMPLETE_RESPONSES\",\n          \"createdTime\": 1738281600000,\n          \"surveyMode\": \"STANDARD\",\n          \"surveyResponseType\": \"STANDARD\",\n          \"responderSnId\": \"6a8c451269baf80612fb6416\",\n          \"responderSnType\": \"EXTERNAL_APPLICATION\",\n          \"responseQuality\": \"NA\",\n          \"questionResponses\": {\n            \"422131e5-67e9-4e7d-8edf-448c7e455f0e\": [\"Neutral\"]\n          },\n          \"customProperties\": {},\n          \"profileCustomProperties\": {},\n          \"transactionCustomProperties\": {}\n        }\n      ],\n      \"metadata\": {\n        \"customFieldLookup\": {},\n        \"questionLookup\": {\n          \"422131e5-67e9-4e7d-8edf-448c7e455f0e\": \"Question\"\n        }\n      }\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"54-response-parameters","__idx":16},"children":["5.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains the survey response details and related metadata."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasMore"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether additional survey responses are available for retrieval."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains the list of survey responses."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the survey associated with the response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the survey response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the survey response. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#111-responsestatus"},"children":["§11.1"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response type. Declared in the schema; not present in the supplied sample."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the survey. Declared in the schema; not present in the supplied sample."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp in milliseconds since Unix epoch, indicating when the response was created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyLanguage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language in which the survey was taken."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyMode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mode in which the survey was conducted. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#112-surveymode"},"children":["§11.2"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyResponseType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of survey response, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STANDARD"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distributionEntityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the distribution entity."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the responder in the source system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responderSnType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source network or channel through which the response was received."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyStartTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp at which the respondent started the survey. Declared in the schema; not present in the supplied sample."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyOpenTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp at which the survey was opened. Declared in the schema; not present in the supplied sample."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tags associated with the response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browser"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Browser used by the respondent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserVersion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version of the browser."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatingSystem"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operating system of the responder."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of device used. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#113-devicetype"},"children":["§11.3"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseQuality"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quality evaluation of the survey response. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#114-responsequality"},"children":["§11.4"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains responses mapped to survey question identifiers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses.questionResponses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<QUESTION_ID>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response value(s) submitted for the corresponding survey question."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom properties associated with the survey response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom properties associated with the responder's profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom properties associated with the survey transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains metadata related to the survey response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains details of any errors encountered. Empty array when the request is successful."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"55-metadata-parameters","__idx":17},"children":["5.5 Metadata parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," object is what makes a response payload human-readable: it maps opaque identifiers back to display names."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains supplementary information used to interpret and map survey response data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.questionLookup"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maps survey question identifiers to their display names."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.questionLookup.<QUESTION_ID>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable name of the corresponding survey question."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.customFieldLookup"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maps custom field identifiers to their corresponding field names or definitions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.customFieldLookup.<CUSTOM_FIELD_ID>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable name of the corresponding custom field. Returned when custom fields are available in the response."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-search-survey-responses","__idx":18},"children":["6. Search survey responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Searches survey responses for a specific survey, with pagination and filtering."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/surveyResponse/search?surveyId={surveyId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["*** ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseFetchRequest"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Survey Response Fetch Request\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Per the Help Center, this operation exists to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Obtain a list of survey responses that fulfill particular filtering criteria, including survey custom properties or responder characteristics… Collect survey responses in large quantities according to specific criteria for the purpose of reporting or integration.\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-query-parameters","__idx":19},"children":["6.1 Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (spec)"},"children":["Required (spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required: false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the survey whose responses are searched."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-request-body","__idx":20},"children":["6.2 Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Two incompatible request-body shapes are documented."]}," Both are reproduced here because neither can be dismissed from the available evidence."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the page number to retrieve. Pagination starts from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the maximum number of records to return per page."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Page"]}," object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pagination descriptor."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start of the page in search results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Size of the page in search results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cursor"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cursor for resuming a paginated search."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters to apply to the search."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the field on which the filter is applied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies values for this filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional details for the filter — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"fieldName\": \"_c_67ce77b1ddff1d4b9bc831ce\"}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"63-documented-filter-types","__idx":21},"children":["6.3 Documented filter types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Search value type"},"children":["Search value type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Filter type"},"children":["Filter type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Matches records where the field value exists in the specified list of values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TOPIC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters data using one or more Topic IDs provided in the filter values."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Values in the supplied table listed as filter types but which are in fact ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["properties"]}," of a filter, not types:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterValues"]}," (spec: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering. For example, topic IDs, category IDs, or other dimension values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimension"]}," (spec: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the dimension or field on which the filter is applied."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V2 documents ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SURVEY_CUSTOM_PROPERTY"]}," as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}," value, paired with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.fieldName"]}," carrying the internal custom-field ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"64-example-request","__idx":22},"children":["6.4 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse/search?surveyId=6a840fb9a64a419291aacd53' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"page\": 0,\n    \"pageSize\": 20\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse/search?surveyId=6a840fb9a64a419291aacd53' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"page\": {\n      \"start\": 0,\n      \"size\": 20\n    },\n    \"filters\": [\n      {\n        \"field\": \"SURVEY_CUSTOM_PROPERTY\",\n        \"filterType\": \"IN\",\n        \"values\": [\"Promoter\"],\n        \"details\": {\n          \"fieldName\": \"_c_67ce77b1ddff1d4b9bc831ce\"\n        }\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"65-example-response","__idx":23},"children":["6.5 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"hasMore\": false\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains the response details returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasMore"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether additional records are available for retrieval. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," means there are no more records."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains details of any errors encountered. Empty array when the request is successful."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-update-survey-response-custom-fields","__idx":24},"children":["7. Update survey response custom fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates the custom fields on an existing survey response. Per the Help Center, use it to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Change particular areas in a survey response, including the modification of tags, custom fields, or metadata… Improve or enhance current replies by adding missing information or making corrections. Utilize this API for performing bulk updates through scripts.\""]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v3/surveyResponse?id={responseId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseUpdateV3Request"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Request body for updating CFM survey response custom fields via API v3.\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-request-parameters","__idx":25},"children":["7.1 Request parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (spec)"},"children":["Required (spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required: false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Survey response ID."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-request-body","__idx":26},"children":["7.2 Request body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Survey response custom fields to update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<CUSTOM_FIELD_KEY>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field identifier and its corresponding value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile custom fields to update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<CUSTOM_FIELD_KEY>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom profile field identifier and its corresponding value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction custom fields to update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<CUSTOM_FIELD_KEY>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom transaction field identifier and its corresponding value."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Only custom fields can be updated."]}," Answers (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},", and every system field are not writable through this endpoint. Despite the method being ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", the operation summary in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}," is ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Update survey response custom fields by id\""]}," — it is scoped to the three custom-field namespaces only."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-example-request","__idx":27},"children":["7.3 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse?id=6a8c451269baf80612fb6417' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"responseCustomFields\": {\n      \"_c_67cb50793cae6f06c0c41de0\": [\"5\"]\n    },\n    \"profileCustomFields\": {\n      \"_c_64cbf526fd8b0e259d72470a\": [\"20\"]\n    },\n    \"transactionCustomFields\": {\n      \"_c_67056c1056182e36198d8eea\": [\"WHATSAPP\"]\n    }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"74-example-response","__idx":28},"children":["7.4 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The sources disagree."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Source"},"children":["Source"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Declared response"},"children":["Declared response"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ref: APIResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supplied specification — \"Example Response\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HTTP/1.1 204 (No Content)"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-delete-survey-responses","__idx":29},"children":["8. Delete survey response(s)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Permanently deletes a survey response using its unique ID. Per the Help Center, use it to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Remove any duplicate, test, or incorrect entries from the system.\""]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v3/surveyResponse?id={responseId}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-request-parameters","__idx":30},"children":["8.1 Request parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (spec)"},"children":["Required (spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required: false"]}," in the OpenAPI specification; ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}," in the supplied endpoint specification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of survey response IDs to delete."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-example-request","__idx":31},"children":["8.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/surveyResponse?id=6a8c451269baf80612fb6417' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-example-response","__idx":32},"children":["8.3 Example response"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Source"},"children":["Source"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Declared response"},"children":["Declared response"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ref: APIResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supplied specification — \"Example Response\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HTTP/1.1 204 (No Content)"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-response-format-and-status-codes","__idx":33},"children":["9. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-the-response-envelope","__idx":34},"children":["9.1 The response envelope"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object or Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The operation payload. An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["object"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},"; an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]}," of wrapper objects on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},"; an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["object"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasMore"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /search"]},". Unconfirmed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of errors. Empty on success."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-status-codes","__idx":35},"children":["9.2 Status codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Declared in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}," for all five operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical cause"},"children":["Typical cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request was processed. Inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," before assuming complete success."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed JSON, an unknown ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]},", an unrecognised custom-field key, a custom-field value sent as a bare string instead of an array, or a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]}," sent as a formatted string instead of epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, expired, or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forbidden"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The caller lacks ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View and Edit Response and Analytics"]}," permission at the survey level, or CFM is not enabled for the environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No survey response exists for the supplied ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," does not exist."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Per the Help Center's testing guidance, a successful ingestion should return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]}," and the response should then be visible in the Sprinklr UI under the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Survey Responses"]}," tab."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-migrating-from-v2","__idx":36},"children":["10. Migrating from V2"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"101-endpoint-mapping","__idx":37},"children":["10.1 Endpoint mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 operation"},"children":["V2 operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 path"},"children":["V2 path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3 equivalent"},"children":["V3 equivalent"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ingest response (bulk or single)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/survey-response"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," in header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/surveyResponse"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," in body)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get responses using filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," body (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," in header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/surveyResponse/search?surveyId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get response by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/survey-response/{survey-response-id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/surveyResponse?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update response by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updates"]}," wrapper (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseID"]}," in header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/surveyResponse?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete response by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseID"]}," in header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/surveyResponse?id="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"102-identifier-passing--the-biggest-behavioural-change","__idx":38},"children":["10.2 Identifier passing — the biggest behavioural change"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the change most likely to break a V2 client silently."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identifier"},"children":["Identifier"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," on ingest"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["header"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["body"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," on search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["header"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameter"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?surveyId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," on get"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path segment"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/survey-response/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameter"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," on update"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["header"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameter"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," on delete"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["header"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameter"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V2 routinely carried business identifiers in headers. V3 moves every one of them into the URL or the body. A client that keeps setting the V2 headers will send them harmlessly but will address no resource, producing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"103-request-body-restructuring","__idx":39},"children":["10.3 Request body restructuring"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ingest — the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFields"]}," wrapper is removed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V2:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"questionResponses\": { \"questionID\": [\"Free-text answer\"] },\n  \"responseTime\": \"2025-03-06 15:00:00\",\n  \"customFields\": {\n    \"responseCustomFields\": { \"_c_67cb50793cae6f06c0c41de0\": [\"5\"] },\n    \"transactionCustomFields\": { \"_c_67056c1056182e36198d8eea\": [\"WHATSAPP\"] },\n    \"profileCustomFields\": { \"_c_64cbf526fd8b0e259d72470a\": [\"20\"] }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V3 — the three objects move to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["top level"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]}," joins them:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"surveyId\": \"6a840fb9a64a419291aacd53\",\n  \"questionResponses\": { \"questionID\": [\"Free-text answer\"] },\n  \"responseTime\": 1738281600000,\n  \"responseCustomFields\": { \"_c_67cb50793cae6f06c0c41de0\": [\"5\"] },\n  \"transactionCustomFields\": { \"_c_67056c1056182e36198d8eea\": [\"WHATSAPP\"] },\n  \"profileCustomFields\": { \"_c_64cbf526fd8b0e259d72470a\": [\"20\"] }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"11-reference-values","__idx":40},"children":["11. Reference values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The enum values below are documented on the V2 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Survey Response"]}," reference page. The corresponding fields in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]}," are declared as unconstrained ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]}," with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no enum"]},", so these values are carried forward from V2 documentation rather than from the V3 specification. They should be added as enums to the V3 schema"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"111-responsestatus","__idx":41},"children":["11.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPLETE_RESPONSES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The respondent completed the survey."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ARCHIVED_RESPONSES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The response has been archived."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IMPORTED_RESPONSES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The response was imported from an external source."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LIVE_RESPONSES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The response is live."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEST_RESPONSES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The response was captured during testing."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"112-surveymode","__idx":42},"children":["11.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyMode"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STANDARD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard survey presentation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONVERSATIONAL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conversational survey presentation."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"113-devicetype","__idx":43},"children":["11.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceType"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPUTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Desktop or laptop computer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOBILE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile phone."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TABLET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tablet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GAME_CONSOLE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Games console."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DMR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Digital media receiver."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WEARABLE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wearable device."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Device type could not be determined."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"114-responsequality","__idx":44},"children":["11.4 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseQuality"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AI-generated quality assessment of the response."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quality assessment has not been generated yet. Returned as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NA"]}," in the V3 sample payload."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["High"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["High-quality response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Medium"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medium-quality response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Low"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Low-quality response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bot"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The system has flagged the submission as a bot response."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"116-filter-fields","__idx":45},"children":["11.6 Filter fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SURVEY_CUSTOM_PROPERTY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter on a survey custom property. Pair with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details.fieldName"]}," carrying the internal custom-field ID. Source: V2 Help Center sample."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"12-use-cases","__idx":46},"children":["12. Use cases"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bulk import of historical responses from a legacy platform."]}," Iterate a legacy export and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," each response with its original ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyLanguage"]},". Per the Help Center this ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Facilitates the automatic integration of large quantities of survey responses from external systems into Sprinklr.\""]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Real-time sync from an offline collection tool."]}," Kiosk or field-agent applications collect feedback without connectivity, then ingest queued responses when the device reconnects, preserving the true ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]}," rather than the upload time."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CRM-triggered feedback capture."]}," When a CRM records a closed case, submit the associated survey response with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomFields"]}," carrying the case attributes, so the response is analysable alongside the interaction that produced it."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Feeding a downstream analytics warehouse."]}," Page through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /search"]}," on a schedule, resolve question IDs via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.questionLookup"]},", and load flattened rows into a warehouse. This ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Enables downstream analytics tools to retrieve or modify response data as required.\""]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Backfilling custom fields on historical responses."]}," A new segmentation attribute is defined after responses were collected. Script a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," across the affected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," values to populate it — the Help Center's documented pattern of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"bulk updates on older responses in light of the latest information for analytical purposes.\""]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enriching responses with profile data resolved later."]}," A response arrives anonymously and the responder is identified afterwards. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," to attach ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomFields"]}," once the identity is known."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correcting a mis-mapped custom field."]}," An ingestion job wrote the wrong internal field name. Fetch the affected responses, then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," the corrected mapping — subject to confirming replace-versus-merge semantics."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purging test and duplicate submissions before reporting."]}," Search for responses with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TEST_RESPONSES"]},", then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," them so they do not distort dashboards."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filtering out low-quality and bot responses."]}," Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseQuality"]}," to identify ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bot"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Low"]}," submissions and either delete them or tag them for exclusion, protecting score integrity."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Auditing a single response after a customer complaint."]}," Fetch by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseId"]}," to inspect exactly what was answered, on what device and browser, and at what time — the audit use case the Help Center describes as ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Obtain a particular reply for examination, auditing, or modification.\""]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data-subject erasure."]}," Search for a responder's submissions, then delete each by ID. Confirm the permanence of deletion before relying on this for a compliance workflow."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"13-caveats-and-best-practices","__idx":47},"children":["13. Caveats and best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify required fields before ingestion."]}," The Help Center is explicit: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Always verify the necessary fields prior to ingestion.\""]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SurveyResponseIngestionRequest"]}," declares no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array, so the server will accept structurally valid but semantically empty payloads. Validate client-side."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Batch large ingestions."]}," Per the Help Center: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Utilize APIs in groups for large-scale data ingestion to minimize overhead.\""]}," No maximum batch size or request-size limit is documented, so keep batches conservative until one is confirmed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filter searches narrowly."]}," Per the Help Center: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Utilize filtering with appropriate fields to refine GET APIs and prevent timeouts.\""]}," An unfiltered search over a high-volume survey is the most likely cause of a timeout on this API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom field values are always arrays of strings."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"5\"]"]},", never ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"5\""]}," and never ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5"]},". This applies on ingest and on update, across all three namespaces."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request and response custom-field names differ."]}," Requests use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseCustomFields"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomFields"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomFields"]},"; responses use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileCustomProperties"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionCustomProperties"]},". Write an explicit bidirectional mapping."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never hard-code question IDs."]}," Resolve them through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata.questionLookup"]}," on every fetch. Question IDs change when a survey is edited or cloned, and some IDs are compound (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<questionId>_<optionId>"]},", as in the V2 sample ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["c958057e-…_778dcad1-…"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," is not a general-purpose update."]}," It writes custom fields only. Answers, status, and system fields cannot be modified through this API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," as potentially destructive until proven otherwise."]}," With replace semantics, a payload containing one custom field could erase all the others."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," does not exist."]}," Do not build against the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," operation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Guard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," client-side."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," is declared optional on a destructive operation. Assert it is non-empty before dispatching, and consider requiring an explicit confirmation flag in any script that deletes in bulk."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test the round trip in the UI."]}," The Help Center recommends starting with a test survey and a test responder address such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test@sprinklr.com"]},", confirming the API returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},", and then ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"verify that the response is visible in the Sprinklr UI under the Survey Responses tab.\""]}," An API success does not by itself prove the response was indexed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Do not assume idempotency."]}," No idempotency key, deduplication window, or uniqueness constraint is documented for ingestion. A retried ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," will most likely create a duplicate response and distort your scores. Deduplicate at the client."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rate limits are undocumented."]}," No rate-limit headers, quotas, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," responses are declared. Build in client-side throttling and exponential backoff regardless."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Timestamps are epoch milliseconds in V3."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyStartTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyOpenTime"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elapsedTime"]}," are all ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},". V2's formatted-string ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseTime"]}," will be rejected."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Keep credentials and session artefacts out of examples."]}," Strip ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cookie: JSESSIONID"]}," headers, and never paste live tokens into tickets or shared Postman collections."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"14-quick-reference","__idx":48},"children":["14. Quick reference"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"141-operations","__idx":49},"children":["14.1 Operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required input"},"children":["Required input"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Success payload"},"children":["Success payload"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["questionResponses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.responseId"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch response(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (comma-separated)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responses[]"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search responses"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse/search?surveyId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyId"]},"; Body: pagination (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#62-request-body"},"children":["shape unsettled"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.hasMore"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update custom fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"; Body: three custom-field objects"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#74-example-response"},"children":["unsettled"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete response(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyResponse?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (comma-separated)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#83-example-response"},"children":["unsettled"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"s","attributes":{},"children":["Partial update"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"s","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Not implemented."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"142-related-cfm-v3-endpoints-not-covered-by-this-guide","__idx":50},"children":["14.2 Related CFM V3 endpoints not covered by this guide"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/trigger"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Trigger a CFM workflow for an existing profile. See the CFM Workflow API V3 developer guide."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/triggerWithNewProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create or update a profile and trigger a CFM workflow. See the CFM Workflow API V3 developer guide."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyTransactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manage CFM transactions. See the CFM Transaction APIs V3 developer guide."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/surveyDistribution/transactions/link"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a personalized survey transaction link."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"143-required-headers","__idx":51},"children":["14.3 Required headers"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Bearer {{accessToken}}\nKey: {{apiKey}}\nContent-Type: application/json      # POST and PUT only\nAccept: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"CFM Survey Response APIs V3 — Developer Guide","id":"cfm-survey-response-apis-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The survey response data model","id":"11-the-survey-response-data-model","depth":3},{"value":"1.2 Addressing a survey response","id":"12-addressing-a-survey-response","depth":3},{"value":"1.3 Prerequisites","id":"13-prerequisites","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Import a survey response","id":"4-import-a-survey-response","depth":2},{"value":"4.1 Request body","id":"41-request-body","depth":3},{"value":"4.2 Example request","id":"42-example-request","depth":3},{"value":"4.3 Example response","id":"43-example-response","depth":3},{"value":"4.4 Response parameters","id":"44-response-parameters","depth":3},{"value":"5. Fetch survey response(s)","id":"5-fetch-survey-responses","depth":2},{"value":"5.1 Request parameters","id":"51-request-parameters","depth":3},{"value":"5.2 Example request","id":"52-example-request","depth":3},{"value":"5.3 Example response","id":"53-example-response","depth":3},{"value":"5.4 Response parameters","id":"54-response-parameters","depth":3},{"value":"5.5 Metadata parameters","id":"55-metadata-parameters","depth":3},{"value":"6. Search survey responses","id":"6-search-survey-responses","depth":2},{"value":"6.1 Query parameters","id":"61-query-parameters","depth":3},{"value":"6.2 Request body","id":"62-request-body","depth":3},{"value":"6.3 Documented filter types","id":"63-documented-filter-types","depth":3},{"value":"6.4 Example request","id":"64-example-request","depth":3},{"value":"6.5 Example response","id":"65-example-response","depth":3},{"value":"7. Update survey response custom fields","id":"7-update-survey-response-custom-fields","depth":2},{"value":"7.1 Request parameters","id":"71-request-parameters","depth":3},{"value":"7.2 Request body","id":"72-request-body","depth":3},{"value":"7.3 Example request","id":"73-example-request","depth":3},{"value":"7.4 Example response","id":"74-example-response","depth":3},{"value":"8. Delete survey response(s)","id":"8-delete-survey-responses","depth":2},{"value":"8.1 Request parameters","id":"81-request-parameters","depth":3},{"value":"8.2 Example request","id":"82-example-request","depth":3},{"value":"8.3 Example response","id":"83-example-response","depth":3},{"value":"9. Response format and status codes","id":"9-response-format-and-status-codes","depth":2},{"value":"9.1 The response envelope","id":"91-the-response-envelope","depth":3},{"value":"9.2 Status codes","id":"92-status-codes","depth":3},{"value":"10. Migrating from V2","id":"10-migrating-from-v2","depth":2},{"value":"10.1 Endpoint mapping","id":"101-endpoint-mapping","depth":3},{"value":"10.2 Identifier passing — the biggest behavioural change","id":"102-identifier-passing--the-biggest-behavioural-change","depth":3},{"value":"10.3 Request body restructuring","id":"103-request-body-restructuring","depth":3},{"value":"11. Reference values","id":"11-reference-values","depth":2},{"value":"11.1 responseStatus","id":"111-responsestatus","depth":3},{"value":"11.2 surveyMode","id":"112-surveymode","depth":3},{"value":"11.3 deviceType","id":"113-devicetype","depth":3},{"value":"11.4 responseQuality","id":"114-responsequality","depth":3},{"value":"11.6 Filter fields","id":"116-filter-fields","depth":3},{"value":"12. Use cases","id":"12-use-cases","depth":2},{"value":"13. Caveats and best practices","id":"13-caveats-and-best-practices","depth":2},{"value":"14. Quick reference","id":"14-quick-reference","depth":2},{"value":"14.1 Operations","id":"141-operations","depth":3},{"value":"14.2 Related CFM V3 endpoints not covered by this guide","id":"142-related-cfm-v3-endpoints-not-covered-by-this-guide","depth":3},{"value":"14.3 Required headers","id":"143-required-headers","depth":3}],"frontmatter":{"seo":{"title":"CFM Survey Response APIs V3 — Developer Guide"}},"lastModified":"2026-10-22T18:13:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/cfm-survey-response-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}