{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Create Listening Theme — API 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":"create-listening-theme--api-v3-developer-guide","__idx":0},"children":["Create Listening Theme — API V3 Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Listening Theme API, version 3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/listening/theme"]},"), OpenAPI tag ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Listening Theme V3"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-theme-2-0"},"children":["Create Theme 2.0"]}," — part of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/listening-2-0"},"children":["Listening 2.0"]}," suite (Create Theme · Read Theme · Update Theme · Delete Theme)"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A registered API application with a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["service account"]}," — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/"},"children":["Getting Started"]}," on the developer portal."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An OAuth access token and an API key."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Theme"]}," permission. Per ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/themes/how-to-access-listening-themes/646379be8ea3c9635cf367a7"},"children":["How to access Listening Themes?"]},", Theme permissions sit under permission category ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversations"]},", permission type ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Listening Settings"]},":"]},{"$$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":"Permission"},"children":["Permission"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Allows"},"children":["Allows"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create new Listening Themes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit Theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Edit existing Listening Themes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete Theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete existing Themes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View Theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View Themes"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Server routing records the server type and backing store for each Listening V3 entity:"]},{"$$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":"V3 API"},"children":["V3 API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Module / Entity (UI)"},"children":["Module / Entity (UI)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Permission (UI name)"},"children":["Permission (UI name)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Server type"},"children":["Server type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Collection / store"},"children":["Collection / store"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Topic"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listeningTopic"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Topic Group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listeningGroup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Listening Theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Listening Settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme View"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listeningTheme"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Backfill"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View (or Topic Backfill)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["historicBackfill"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keyword List"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keyword Group View"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFAULT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywordGroup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert Manager"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View or Admin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFAULT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alert"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":2},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-what-a-listening-theme-is","__idx":3},"children":["1.1 What a Listening Theme is"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Listening Theme is a set of keywords and filters that can be used to sort Listening Insights data across a pre-built area of focus. Consider Themes like a sub-topic or a lens that can be associated to slice and dice your topics around different aspects and attributes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The critical property, and the reason Themes exist as a separate entity from Topics:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Listening Themes helps to visualize data ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["without changing what a Topic pulls into the Sprinklr platform"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Topic"]}," controls ingestion — it determines which conversations enter Sprinklr at all. A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme"]}," is a read-time lens over data a Topic has already collected. Creating, changing, or deleting a Theme therefore never changes your ingested volume or your data bill; it changes only how existing mentions are segmented for analysis. Typical Themes are segments such as Product Quality, Customer Service, Pricing, or Delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, refer to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/themes/introduction-to-listening-themes/64637c4b30f12540268faa7f"},"children":["Introduction to Listening Themes"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-where-a-theme-sits-in-the-listening-model","__idx":4},"children":["1.2 Where a Theme sits in the Listening model"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Keyword List ──┐\n ├──> Topic ──> ingests mentions ──> Theme ──> segments them for analysis\nBoolean query ─┘ │\n └──> applied to dashboards, widgets,\n alerts, and rules (via Theme Tags)\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Themes are step 5 — applied after Topics exist and are collecting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"13-when-to-use-the-api-instead-of-the-ui","__idx":5},"children":["1.3 When to use the API instead of the UI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The UI offers two creation routes, per ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/theme-creation-setup/create-listening-themes/6464a57f30f12540268fad05"},"children":["Create Listening Themes"]},": the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme builder"]},", and the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme Library"]},", which contains ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"5000+ readily available Themes based on various categories and different industries.\""]}," There is also ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/categories/theme-creation-setup/63f70a7b2e54736196aa5114"},"children":["Bulk Import Themes"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/sprinklr-ai/use-sprinklr-ai-to-create-listening-themes-automatically/646b6f6930f12540268fbf29"},"children":["AI+ automatic Theme framework creation"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reach for the API when you need to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Provision programmatically"]}," — create the same Theme taxonomy across many environments or client accounts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sync from an external source"]}," — mirror a product taxonomy, a CRM category tree, or a support-ticket schema into Themes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Version-control your taxonomy"]}," — keep Theme definitions in Git and apply them via CI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate Themes"]}," — create one Theme per SKU, region, or campaign from a data source, at a volume that makes manual creation impractical."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The UI is better when a human needs the Theme Editor's live preview, which the API has no equivalent of: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"the Theme Editor UI has preview support, meaning social posts, conversations, smart clusters, etc., can be previewed immediately while creating the Themes.\""]}," There is no API dry-run."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"14-conventions-in-this-guide","__idx":6},"children":["1.4 Conventions in this guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{base}"]}," stands for the host and environment prefix resolved."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Credentials always appear as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{accessToken}}"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}," placeholders. Never paste a real key into a shared document or a ticket."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fields are shown exactly as they appear in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},"; casing is significant."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":7},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{base} = https://{host}/{env}\n"},"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":"Segment"},"children":["Segment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{host}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Issued with your application registration. The V2 Create Theme page documents ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api3.sprinklr.com"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your environment prefix."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full create URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST https://api3.sprinklr.com/{env}/api/v3/listening/theme\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":8},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/developer-tools/developer-tools-in-sprinklr/692e8b39f0afa271d18a5929"},"children":["Developer Tools in Sprinklr"]}," for 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"]},{"$$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":["The API key acts as both a unique identifier and a secret token for authentication to a set of access rights"]},{"$$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":["Request format should be JSON, as the endpoint expects a JSON body"]},{"$$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-post-create-listening-theme","__idx":9},"children":["4. POST: Create Listening Theme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Create a Listening Theme."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningThemeApiV3_createTheme"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Declared errors."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 reference."]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-theme-2-0"},"children":["Create Theme 2.0"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V2 page describes the contract precisely, and it holds in V3:"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\"You can create a Listening Theme via this API call and you will get the complete Listening Theme object along with unique Theme Id as response after making the request.\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the response is the full object, not just an id — read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from it and store that as your handle for later ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," calls."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-parameters","__idx":10},"children":["4.1 Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["None."]}," The create operation declares no path, query, header, or parameters. Everything travels in the body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This differs from the other three methods on this path, all of which take an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," query parameter."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-required-fields","__idx":11},"children":["4.2 Required fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," declares exactly two required properties:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"required:\n- name\n- filters\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Everything else is optional. A minimum viable create body is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"name\": \"customer_service\",\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n {\n \"advanceQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\",\n \"textQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\"\n }\n ]\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-example-request","__idx":12},"children":["4.3 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n 'https://api3.sprinklr.com/{env}/api/v3/listening/theme' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -H 'Accept: application/json' \\\n -d '{\n \"name\": \"ListeningThemeAPITest\",\n \"displayName\": \"Customer Service\",\n \"color\": \"#4CAF50\",\n \"iconUrl\": \"https://cdn.example.com/icons/customer-service.png\",\n \"description\": \"Customer service related conversations and inquiries\",\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n {\n \"advanceQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\",\n \"textQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\"\n }\n ]\n }\n ],\n \"tags\": [\"cs\", \"support\", \"priority\"],\n \"shareConfigs\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] }\n ],\n \"permissions\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] }\n ]\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Illustrative example. Values are placeholders; substitute your own ids, keyword-list ids, and credentials."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-example-response","__idx":13},"children":["4.4 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"60486cef06ebe67ed55c4140\",\n \"name\": \"ListeningThemeAPITest\",\n \"displayName\": \"Customer Service\",\n \"color\": \"#4CAF50\",\n \"iconUrl\": \"https://cdn.example.com/icons/customer-service.png\",\n \"description\": \"Customer service related conversations and inquiries\",\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n {\n \"advanceQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\",\n \"textQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\"\n }\n ],\n \"details\": {}\n }\n ],\n \"tags\": [\"cs\", \"support\", \"priority\"],\n \"shareConfigs\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] }\n ],\n \"permissions\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note what the V2 response echoed back that the V3 schema does not model: V2 returned filter sub-fields ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allValuesAllowed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["favourite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mandatory"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locked"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," populated with server defaults. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," models only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},". If the server still returns those extra keys, your JSON parser must tolerate unmodelled properties."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-the-listeningtheme-object","__idx":14},"children":["5. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the create request body and the response body. Unusually for the V3 contract, every property carries a description in the spec."]},{"$$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":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description (from sprinklr-v3.yaml )"},"children":["Description (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},")"]}]}]},{"$$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":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the Listening Theme in Sprinklr. Server-assigned; omit on create."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme display name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iconUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme icon url."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme image url."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme identification color."]}]},{"$$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":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter list to filter out required data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme description."]}]},{"$$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":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tags to group Listening Theme based on use case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share config to view Listening Theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permission config to edit or update Listening Theme."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema description: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Unified view of a Listening Theme in Sprinklr.\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-name-versus-displayname","__idx":15},"children":["5.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Name"]}," versus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisplayName"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The spec distinguishes them but does not say how they differ in behaviour. The V2 example is instructive: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"name\": \"ListeningThemeAPITest\""]}," alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"displayName\": \"sampleCreateThemeDisplayName1\""]}," — a machine-ish identifier and a human label.Read Theme example follows the same pattern: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"name\": \"customer_service\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"displayName\": \"Customer Service\""]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Recommended convention: use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," as a stable, lower-case, underscore-separated key you control, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}," as the label analysts see. Whether ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," must be unique per environment is unspecified."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-tags","__idx":16},"children":["5.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tags"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Plain array of strings on the wire. In the product these become ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme Tags"]},", which are considerably more powerful than the flat type suggests. Per ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/categories/using-themes/63f70a832e54736196aa53f0"},"children":["Using Themes"]},":"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\"Theme Tags can be used across the Listening module to group and use multiple Themes at once. They can be used as — Filters in dashboards, Dimensions in widgets, Filters in alerts, Conditions in rules.\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tag deliberately. A tag applied at create time is what later lets a dashboard filter, a widget dimension, an alert, or a rule address a whole family of Themes at once, without enumerating ids."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-color--iconurl--image-url","__idx":17},"children":["5.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Color"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IconUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Image Url"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Presentation metadata surfaced in the Themes record manager and in dashboards. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color"]}," is documented as the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"identification color\""]},"; the V2 example uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"#FFFFF\""]}," — five hex digits, which is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not a valid CSS hex colour"]},". Read example uses a valid six-digit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"#4CAF50\""]},". This guide uses six digits. Whether the field is validated is unknown. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#18-questions-for-the-api-owner"},"children":["§18, Q9"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-filters","__idx":18},"children":["6. Filters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," is one of the two required fields and the one most likely to cause a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},". It is an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-filter_shifu-schema","__idx":19},"children":["6.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema description: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Describes the schema for filters in Sprinklr.\""]}]},{"$$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":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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 field on which filter is applied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of 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":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional details for 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":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Nested filters"]}," — the schema is recursive."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-the-values-that-actually-work","__idx":20},"children":["6.2 The values that actually work"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Specification gap — no enums anywhere."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}," are declared as bare ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," with no enum, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," is an array of untyped ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]},". The V3 contract will accept any string for either. The only known-good combination in any source is the one from the V2 Create Theme example, reproduced below."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V2 page's working example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n {\n \"advanceQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\",\n \"textQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\"\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reading that: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field: \"QUERY\""]}," says ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["filter on the query expression"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType: \"IN\""]}," says ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["match against the supplied values"]},"; and each value object carries a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["paired"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advanceQuery"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textQuery"]},", both set to the same expression. The expression ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keyword_list_or(\"\")"]}," matches a mention if any keyword in that Keyword List matches — which is how a Theme reuses a Keyword List rather than restating its keywords."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the pairing of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advanceQuery"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textQuery"]},". The V2 example sets both to the identical string, and this guide does the same. Their intended difference is undocumented. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#18-questions-for-the-api-owner"},"children":["§18, Q10"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"63-the-enum-that-exists-but-does-not-apply","__idx":21},"children":["6.3 The enum that exists but does not apply"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," request schema uses a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different"]}," filter type, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]},", whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["does"]}," carry an enum — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FilterType_Filter"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"FILTER · LIMIT · SEARCH · MATCH_PHRASE_PREFIX · ADHOC_SEARCH ·\nEXPRESSION · GEO_DISTANCE · ADVANCED_QUERY · MATCH_NONE · MATCH_ALL\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," also carries fifteen properties ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," lacks — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompoundFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["negativeFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessibleValues"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allValuesAllowed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lockedWithValues"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hidden"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["favourite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mandatory"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locked"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ignoreAddingToDimensionFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disabled"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advancedFilters"]},". Several of those (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allValuesAllowed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["favourite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mandatory"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locked"]},") are exactly the keys the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 create response"]}," echoed back, which suggests ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," is closer to the real internal model and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," is a reduced projection."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"64-nested-filters","__idx":22},"children":["6.4 Nested filters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both filter schemas are recursive via their own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," property, so compound logic is expressible by nesting. No source supplies a worked nested example, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," has no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["negativeFilter"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompoundFilter"]}," flag to declare how children combine — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," has both. How nested ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," children are combined (AND, OR) is unspecified. Prefer a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advanceQuery"]}," expression with Boolean operators over nesting until this is confirmed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"65-location-based-themes","__idx":23},"children":["6.5 Location-based Themes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Help Center documents ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/categories/theme-creation-setup/63f70a7b2e54736196aa5114"},"children":["Creating location-based Themes"]},":"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\"In Listening Themes, you have the ability to filter data on the basis of the location of a message. Messages can be filtered out for a specific location by selecting the latitude, longitude, and radius of the search (in kilometers or miles). Note: To learn more about getting this capability enabled…\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FilterType_Filter"]}," includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GEO_DISTANCE"]},", which is plainly the mechanism. But no source documents the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}," name or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," shape (latitude, longitude, radius, unit) for a geo filter, and the capability requires enablement. Build geo Themes in the UI and read them back with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," to learn the exact shape."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-sharing-and-permissions","__idx":24},"children":["7. Sharing and permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Two optional arrays control who can see and who can edit a Theme. Both use the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}," schema."]},{"$$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":"Purpose (from the spec)"},"children":["Purpose (from the spec)"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Share config to view Listening Theme\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Permission config to edit or update Listening Theme\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-assetshareconfig","__idx":25},"children":["7.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema description: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Describes the schema for Asset Share config.\""]}]},{"$$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":"Required"},"children":["Required"]},{"$$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":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IDs based on type."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is required whenever you supply an entry. The description gives three examples — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}," — introduced with *\"e.g.\", so the list is illustrative, not exhaustive, and there is no enum. The V2 model additionally distinguished user ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["groups"]}," and client ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["groups"]},"; whether V3 expresses those as further ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," values (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER_GROUP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT_GROUP"]},") is not stated anywhere. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#18-questions-for-the-api-owner"},"children":["§18, Q14"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"shareConfigs\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\", \"600037831\"] },\n { \"type\": \"CLIENT\", \"ids\": [\"66000002\"] }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-sharing-with-everyone","__idx":26},"children":["7.2 Sharing with everyone"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V2 had an explicit boolean, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig.shareWithEveryOne"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}," has ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no boolean at all"]},". The likely V3 equivalent is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"type\": \"GLOBAL\"}"]}," — possibly with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," omitted, since ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," is optional and a global share has no specific target. This is inference from the type name, not documented behaviour."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-id-types-changed","__idx":27},"children":["7.3 Id types changed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In V2, user and client ids were ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["List"]}," — JSON numbers. In V3, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig.ids"]}," is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array of string"]},". Quote your ids:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"diff","header":{"controls":{"copy":{}}},"source":"- \"userIds\": [600000000]\n+ \"ids\": [\"600000000\"]\n","lang":"diff"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A client that forwards V2 numeric ids into the V3 array will send numbers where strings are expected. Whether the server coerces them is unverified — quote them and avoid the question."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-response-format-and-status-codes","__idx":28},"children":["8. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-the-envelope-question","__idx":29},"children":["8.1 The envelope question"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note also the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array. V2 returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"errors\": []"]}," on success, which implies a partial-success mode where a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," carries errors. Always inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," even on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},". Its element shape is undocumented. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#18-questions-for-the-api-owner"},"children":["§18, Q17"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-declared-status-codes","__idx":30},"children":["8.2 Declared status codes"]},{"$$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":"Declared?"},"children":["Declared?"]}]}]},{"$$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 — theme created, full object returned."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$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 — malformed body, missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", invalid filter."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$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 — missing, expired, or invalid token."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$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 — authenticated but lacking the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Theme"]}," permission."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$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 — declared on create, though its meaning there is unclear."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate limited."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Not declared"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Not declared"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-error-responses","__idx":31},"children":["8.3 Error responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All four operations return the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["same error schema"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," — the shared ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}," component."]},{"$$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":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description (from sprinklr-v3.yaml )"},"children":["Description (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},")"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Schema"},"children":["Schema"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BadRequest"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unauthorized"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or invalid authentication"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Forbidden"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotFound"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource not found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]},":"]}]},{"$$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, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["nullable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null or empty on an error."]}]},{"$$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 failures."]}]},{"$$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":["Undescribed in the spec."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}]}," — all three properties are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},":"]},{"$$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 (from sprinklr-v3.yaml )"},"children":["Description (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},")"]}]}]},{"$$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":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["24-character hex ObjectId"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["— (no description)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dotted error key (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"data\": null,\n \"errors\": [\n {\n \"id\": \"66badc8a6df5bf43f6c8f374\",\n \"code\": 400,\n \"message\": \"listening.theme.name.required\"\n }\n ],\n \"metadata\": {}\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Illustrative — the shape is from the schema, the literal values are invented. No source publishes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," values or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}," keys for Listening Theme."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Specification gap — no error catalogue."]}," No source publishes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," values or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}," keys this API emits, so you cannot write exhaustive error handling in advance. Log the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array on every failure and build your catalogue from observed traffic. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#18-questions-for-the-api-owner"},"children":["§16, Q33"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-get-fetch-listening-themes","__idx":32},"children":["9. GET: Fetch Listening Themes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Fetch Listening Theme(s) by id. Supports bulk fetch."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningThemeApiV3_getThemes"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," None."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Declared errors."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 reference."]}," Read Theme 2.0, part of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/listening-2-0"},"children":["Listening 2.0"]}," suite."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the only Theme operation with a Jira description, a worked example, and recorded production verification. It is also, paradoxically, the operation whose documented response ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["least resembles the OpenAPI schema"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-parameters","__idx":33},"children":["9.1 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 (from sprinklr-v3.yaml )"},"children":["Description (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},")"]}]}]},{"$$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":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of Listening Theme id"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-bulk-fetch","__idx":34},"children":["9.2 Bulk fetch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The parameter description — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Comma-separated list of Listening Theme id\""]}," — is what makes this operation bulk-capable, and the response is typed as an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]}," even for a single id. Always iterate the result; never index ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[0]"]}," blindly."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=66badc8a6df5bf43f6c8f374,60486cef06ebe67ed55c4140' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No source states an upper bound on how many ids one call accepts, whether the ids must all resolve, or what happens when one id in the list is invalid — does the whole call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},", or does it return the ones that resolved and report the rest in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nor is there any pagination, sorting, or filtering mechanism on this operation: no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]},", or name-search parameter is declared. If you do not already know a Theme's id, the V3 API as specified gives you no documented way to discover it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-example-response","__idx":35},"children":["9.3 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Per the OpenAPI document, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," body is an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," objects:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n {\n \"id\": \"66badc8a6df5bf43f6c8f374\",\n \"name\": \"customer_service\",\n \"displayName\": \"Customer Service\",\n \"iconUrl\": \"https://cdn.example.com/icons/customer-service.png\",\n \"color\": \"#4CAF50\",\n \"description\": \"Customer service related conversations and inquiries\",\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n { \"advanceQuery\": \"support OR help OR issue\", \"textQuery\": \"support OR help OR issue\" }\n ],\n \"details\": {}\n }\n ],\n \"tags\": [\"cs\", \"support\", \"priority\"],\n \"shareConfigs\": [ { \"type\": \"USER\", \"ids\": [\"600000000\"] } ],\n \"permissions\": [ { \"type\": \"USER\", \"ids\": [\"600000000\"] } ]\n }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Illustrative, constructed from the OpenAPI schema."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-the-response-example-does-not-match-the-schema","__idx":36},"children":["9.4 The response example does not match the schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This deserves its own subsection, because it is the sharpest source disagreement in this guide and it affects anyone writing a response parser."]},{"$$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 in the ticket example"},"children":["Field in the ticket example"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In ListeningTheme ?"},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]},"?"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appliedToTopics"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of topic ids. Would be the Theme→Topic association — a genuinely useful field with no schema counterpart."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A whole nested object, described below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow.assignment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{assigneeId, assigneeType, assignedById, assignmentTime}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow.customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map of string → array of string."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow.permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{type, id, role}"]}," — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["singular ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", plus a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role"]}]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow.tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Top-level only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ticket nests ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}," inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow"]},"; the schema has it at the top level."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow.shareConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{sharedWithTeams, visibility}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdBy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedBy"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audit metadata."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Epoch-millisecond timestamps."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean — the same field the V2 create example carried."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["And three fields that exist but in a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different shape"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," is an object, not an array."]}," The ticket shows ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"filters\": {\"keywords\": [...], \"sentiment\": [...], \"priority\": \"HIGH\"}"]},". The schema says array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},". The V2 page shows an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{filterType, field, values}"]},". ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["That is three mutually incompatible shapes for the single most important field on the entity."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The id field is called ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themeId"]},"."]}," The ticket's response-fields table lists ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themeId"]}," as ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"The unique identifier of the Listening Theme\""]},", while the ticket's own JSON example uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and the schema uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}," is singular and differently shaped"]}," — a fourth variant, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{sharedWithTeams, visibility}"]},", alongside the create model (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}," array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{type, ids}"]},"), the patch model (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}," object of id lists), and the V2 model."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to read this."]}," The ticket's example JSON is also ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["syntactically malformed"]}," — the id line reads ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id\": \"66badc8a…"]}," with the opening quote missing — which indicates it was hand-written into the ticket rather than captured from a live response. Combined with the invented ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflow"]}," envelope and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themeId"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," mismatch inside a single section, the example should be treated as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["illustrative prose, not observed behaviour"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Per this programme's precedence rule, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["the OpenAPI document outranks Jira description text"]},", so this guide documents the schema shape. But the risk cuts both ways: if any part of the ticket example reflects reality, a strict parser bound to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," will break. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parse permissively — tolerate unknown properties, and do not fail on a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," value that arrives as an object."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"95-verified-get-scenarios","__idx":37},"children":["9.5 Verified GET scenarios"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following request and response scenarios supplement the GET contract with tested single-ID, multiple-ID, partial-success, and request-limit examples."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"951-retrieve-a-theme-by-id-basic-response","__idx":38},"children":["9.5.1 Retrieve a Theme by ID: Basic Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the Listening Theme to retrieve. Pass the theme ID as a query parameter in the request URL."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":39},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location '<{{baseUrl}}/api/v3/listening/theme?id=69957998530c7a6ee53206eb>' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}' \\\\\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response","__idx":40},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": \\[\n\n{\n\n\"id\": \"69957998530c7a6ee53206eb\",\n\n\"name\": \"Theme_Search_1771403672289\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"advanceQuery\": \"Google AND Facebook\",\n\n\"textQuery\": \"(\\\\Google\\\\ AND \\\\Facebook\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"raw_search\": false,\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"ALERT_TAG_DND\"\n\n\\],\n\n\"shareConfigs\": \\[\n\n{\n\n\"type\": \"GLOBAL\"\n\n}\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\\]\n\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters","__idx":41},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Listening Theme objects returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operator applied to the field. Example: IN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or field on which the filter is applied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["advanceQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced query definition used by the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["textQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parsed text representation of the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["themesInQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of referenced themes used within the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw_search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether raw search is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of filter criteria configured."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters applied within the current filter. Returns an empty array when no nested filters exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing configuration for the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing scope for the theme. Example: GLOBAL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of errors encountered during request processing. Returns an empty array when the request is successful."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"96-retrieve-a-theme-by-id-additional-basic-response","__idx":42},"children":["9.6 Retrieve a Theme by ID: Additional Basic Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-1","__idx":43},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location '<{{baseUrl}}/api/v3/listening/theme?id=69957998530c7a6ee53206eb>' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}' \\\\\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-parameters","__idx":44},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the Listening Theme to retrieve. Pass the Theme ID as a query parameter in the request URL."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-1","__idx":45},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": \\[\n\n{\n\n\"id\": \"69957998530c7a6ee53206eb\",\n\n\"name\": \"Theme_Search_1771403672289\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"advanceQuery\": \"Google AND Facebook\",\n\n\"textQuery\": \"(\\\\Google\\\\ AND \\\\Facebook\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"raw_search\": false,\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"ALERT_TAG_DND\"\n\n\\],\n\n\"shareConfigs\": \\[\n\n{\n\n\"type\": \"GLOBAL\"\n\n}\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\\]\n\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-1","__idx":46},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Listening Theme objects returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operator applied to the field. Example: IN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or field on which the filter is applied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["advanceQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced query expression used in the theme filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["textQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text representation of the advanced query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["themesInQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of referenced themes used within the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw_search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether raw search mode is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of filter configuration. Example: criteria."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters defined within the current filter. Returns an empty array when no nested filters exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing configuration for the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing scope of the theme. Example: GLOBAL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of errors encountered during request processing. Returns an empty array when the request succeeds."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"97-retrieve-a-theme-by-id-complex-filters","__idx":47},"children":["9.7 Retrieve a Theme by ID: Complex Filters"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-2","__idx":48},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/theme?id=6995af98d7890350f0d74510' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}'\n\n**Request Parameters**\n\n| **Parameter** | **Sub-parameter** | **Required** | **Type** | **Description** |\n|----|----|----|----|----|\n| id | N/A | Yes | String | Unique identifier of the Listening Theme to retrieve. Pass the Theme ID as a query parameter in the request URL |\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-2","__idx":49},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": \\[\n\n{\n\n\"id\": \"6995af98d7890350f0d74510\",\n\n\"name\": \"Test-Theme-with-API\",\n\n\"displayName\": \"Test-Theme-with-API\",\n\n\"color\": \"#ca6969\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"orConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"AND\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"67e657633d78d4090467b7e0\",\n\n\"operator\": \"AND\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"andConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"6983038bdc0d4e0888a19de6\",\n\n\"operator\": \"OR\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"excludeConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\n\n{\n\n\"term\": \"black\",\n\n\"keywordType\": \"EXCLUDE_KEYWORD\",\n\n\"distance\": 0\n\n}\n\n\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"textQuery\": \"(\\\\Rolex\\\\ AND (\\\\handcrafted clothing\\\\ OR \\\\artisan fashion\\\\ OR \\\\unique garments\\\\ OR \\\\fashion craftsmanship\\\\) AND NOT \\\\black\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n},\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"POINT_RADIUS_LOCATION\",\n\n\"values\": \\[\n\n{\n\n\"type\": \"POINT_RADIUS\",\n\n\"locationName\": \"G33W+946 Ambience Island, DLF Phase 3, Sector 24, Gurugram, Haryana, India\",\n\n\"latitude\": 28.5034,\n\n\"longitude\": 77.0953,\n\n\"radius\": 10,\n\n\"unit\": \"mi\",\n\n\"id\": \"28.5034_77.0953\"\n\n}\n\n\\],\n\n\"details\": {},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"Air Travel Preferences\",\n\n\"Credit Products - Retail Bank\"\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\\]\n\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-2","__idx":50},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Listening Theme objects returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["displayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name of the theme shown in the user interface."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["color"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hex color code associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operator applied to the field. Example: IN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or field on which the filter is applied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of OR conditions used in the query definition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of topic keywords included in the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator applied to the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["References to keyword groups used in the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the referenced keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator associated with the keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ordered"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether keyword ordering is enforced."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["nearDistance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distance value used with proximity-based matching."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["andConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of AND conditions used in the query definition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludeConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of exclusion conditions used in the query definition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["term"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Excluded keyword term."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Excluded keyword type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["distance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distance value for the excluded keyword."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["textQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable representation of the complete query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["themesInQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referenced themes used within the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter configuration type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters associated with the current filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Can also represent location-based fields such as POINT_RADIUS_LOCATION."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location filter type. Example: POINT_RADIUS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["locationName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the configured location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["latitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["longitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Longitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["radius"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Radius around the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unit used for the radius (for example, mi)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the location filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of errors encountered during request processing. Returns an empty array when the request succeeds"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"98-retrieve-multiple-themes-all-found","__idx":51},"children":["9.8 Retrieve Multiple Themes: All Found"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of Listening Theme IDs to retrieve. The API returns details for each valid Theme identifier provided."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-3","__idx":52},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/theme?id=69957998530c7a6ee53206eb%2C6995af98d7890350f0d74510' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-3","__idx":53},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": \\[\n\n{\n\n\"id\": \"69957998530c7a6ee53206eb\",\n\n\"name\": \"Theme_Search_1771403672289\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"advanceQuery\": \"Google AND Facebook\",\n\n\"textQuery\": \"(\\\\Google\\\\ AND \\\\Facebook\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"raw_search\": false,\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"ALERT_TAG_DND\"\n\n\\],\n\n\"shareConfigs\": \\[\n\n{\n\n\"type\": \"GLOBAL\"\n\n}\n\n\\]\n\n},\n\n{\n\n\"id\": \"6995af98d7890350f0d74510\",\n\n\"name\": \"Test-Theme-with-API\",\n\n\"displayName\": \"Test-Theme-with-API\",\n\n\"color\": \"#ca6969\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"orConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"AND\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"67e657633d78d4090467b7e0\",\n\n\"operator\": \"AND\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"andConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"6983038bdc0d4e0888a19de6\",\n\n\"operator\": \"OR\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"excludeConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\n\n{\n\n\"term\": \"black\",\n\n\"keywordType\": \"EXCLUDE_KEYWORD\",\n\n\"distance\": 0\n\n}\n\n\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"textQuery\": \"(\\\\Rolex\\\\ AND (\\\\handcrafted clothing\\\\ OR \\\\artisan fashion\\\\ OR \\\\unique garments\\\\ OR \\\\fashion craftsmanship\\\\) AND NOT \\\\black\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n},\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"POINT_RADIUS_LOCATION\",\n\n\"values\": \\[\n\n{\n\n\"type\": \"POINT_RADIUS\",\n\n\"locationName\": \"G33W+946 Ambience Island, DLF Phase 3, Sector 24, Gurugram, Haryana, India\",\n\n\"latitude\": 28.5034,\n\n\"longitude\": 77.0953,\n\n\"radius\": 10,\n\n\"unit\": \"mi\",\n\n\"id\": \"28.5034_77.0953\"\n\n}\n\n\\],\n\n\"details\": {},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"Air Travel Preferences\",\n\n\"Credit Products - Retail Bank\"\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\\]\n\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-3","__idx":54},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Listening Theme objects returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["displayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name of the theme shown in the user interface."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["color"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hex color code associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operator applied to the field. Example: IN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or field on which the filter is applied. Examples: QUERY, POINT_RADIUS_LOCATION."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["advanceQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced query expression used in the theme filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["textQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text representation of the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["themesInQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of referenced themes used in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of OR conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["andConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of AND conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludeConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of exclusion conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keywords used in the OR condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator applied to the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["References to keyword groups used in the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the referenced keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator applied to the referenced keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["term"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Excluded keyword term."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of excluded keyword."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["distance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distance value for the keyword."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw_search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether raw search mode is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter configuration type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters associated with the current filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location filter type. Example: POINT_RADIUS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["locationName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the configured location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["latitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["longitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Longitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["radius"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Radius around the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unit used for the radius."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the location filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing configuration for the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing scope for the theme. Example: GLOBAL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of errors encountered during request processing. Returns an empty array when the request succeeds."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"99-retrieve-multiple-themes-partial-success","__idx":55},"children":["9.9 Retrieve Multiple Themes: Partial Success"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of Listening Theme IDs to retrieve. The request can include valid IDs, invalid IDs, non-existent IDs, and empty values. The API attempts to retrieve all valid themes and returns errors for invalid entries."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-4","__idx":56},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/theme?id=69957998530c7a6ee53206eb%2C6995af98d7890350f0d74510%2CINVALID%2Cabcd%2C%2Ctest%2C6995af98d7890350f0d74511' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-4","__idx":57},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": \\[\n\n{\n\n\"id\": \"69957998530c7a6ee53206eb\",\n\n\"name\": \"Theme_Search_1771403672289\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"advanceQuery\": \"Google AND Facebook\",\n\n\"textQuery\": \"(\\\\Google\\\\ AND \\\\Facebook\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"raw_search\": false,\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"ALERT_TAG_DND\"\n\n\\],\n\n\"shareConfigs\": \\[\n\n{\n\n\"type\": \"GLOBAL\"\n\n}\n\n\\]\n\n},\n\n{\n\n\"id\": \"6995af98d7890350f0d74510\",\n\n\"name\": \"Test-Theme-with-API\",\n\n\"displayName\": \"Test-Theme-with-API\",\n\n\"color\": \"#ca6969\",\n\n\"filters\": \\[\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": \\[\n\n{\n\n\"orConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"AND\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"67e657633d78d4090467b7e0\",\n\n\"operator\": \"AND\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"andConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\n\n{\n\n\"keywordGroupId\": \"6983038bdc0d4e0888a19de6\",\n\n\"operator\": \"OR\"\n\n}\n\n\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"excludeConditions\": \\[\n\n{\n\n\"topicKeywords\": \\[\n\n{\n\n\"term\": \"black\",\n\n\"keywordType\": \"EXCLUDE_KEYWORD\",\n\n\"distance\": 0\n\n}\n\n\\],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": \\[\\],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n\\],\n\n\"textQuery\": \"(\\\\Rolex\\\\ AND (\\\\handcrafted clothing\\\\ OR \\\\artisan fashion\\\\ OR \\\\unique garments\\\\ OR \\\\fashion craftsmanship\\\\) AND NOT \\\\black\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n},\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"POINT_RADIUS_LOCATION\",\n\n\"values\": \\[\n\n{\n\n\"type\": \"POINT_RADIUS\",\n\n\"locationName\": \"G33W+946 Ambience Island, DLF Phase 3, Sector 24, Gurugram, Haryana, India\",\n\n\"latitude\": 28.5034,\n\n\"longitude\": 77.0953,\n\n\"radius\": 10,\n\n\"unit\": \"mi\",\n\n\"id\": \"28.5034_77.0953\"\n\n}\n\n\\],\n\n\"details\": {},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"Air Travel Preferences\",\n\n\"Credit Products - Retail Bank\"\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\n\n{\n\n\"id\": \"6995b00af58d8b601be9ed3e\",\n\n\"code\": 404,\n\n\"message\": \"Listening_theme not found for id: 'INVALID'. Verify the listening_theme exists and you have access permissions.\"\n\n},\n\n{\n\n\"id\": \"6995b00af58d8b601be9ed3f\",\n\n\"code\": 404,\n\n\"message\": \"Listening_theme not found for id: 'abcd'. Verify the listening_theme exists and you have access permissions.\"\n\n},\n\n{\n\n\"id\": \"6995b00af58d8b601be9ed3d\",\n\n\"code\": 400,\n\n\"message\": \"Invalid id format: ''. Value cannot be empty or blank.\"\n\n},\n\n{\n\n\"id\": \"6995b00af58d8b601be9ed40\",\n\n\"code\": 404,\n\n\"message\": \"Listening_theme not found for id: 'test'. Verify the listening_theme exists and you have access permissions.\"\n\n},\n\n{\n\n\"id\": \"6995b00af58d8b601be9ed41\",\n\n\"code\": 404,\n\n\"message\": \"Listening_theme not found for id: '6995af98d7890350f0d74511'. Verify the listening_theme exists and you have access permissions.\"\n\n}\n\n\\]\n\n}\n\n**Response Parameters**\n\n| **Parameter** | **Sub-parameter** | **Type** | **Description** |\n|----|----|----|----|\n| data | N/A | Array | List of Listening Theme objects successfully retrieved by the API. |\n| data | id | String | Unique identifier of the theme. |\n| data | name | String | Name of the theme. |\n| data | displayName | String | Display name of the theme shown in the user interface. |\n| data | color | String | Hex color code associated with the theme. |\n| data | filters | Array | List of filters associated with the theme. |\n| data.filters | filterType | String | Filter operator applied to the field. Example: IN. |\n| data.filters | field | String | Dimension or field on which the filter is applied. Examples: QUERY, POINT_RADIUS_LOCATION. |\n| data.filters | values | Array | List of values used for filtering. |\n| data.filters.values | advanceQuery | String | Advanced query expression used in the theme filter. |\n| data.filters.values | textQuery | String | Text representation of the query. |\n| data.filters.values | themesInQuery | Array | List of referenced themes used within the query. |\n| data.filters.values | orConditions | Array | Collection of OR conditions configured in the query. |\n| data.filters.values | andConditions | Array | Collection of AND conditions configured in the query. |\n| data.filters.values | excludeConditions | Array | Collection of exclusion conditions configured in the query. |\n| data.filters | details | Object | Additional filter configuration details. |\n| data.filters.details | raw_search | Boolean | Indicates whether raw search mode is enabled. |\n| data.filters.details | type | String | Type of filter configuration. |\n| data.filters | filters | Array | Nested filters associated with the current filter. |\n| data | tags | Array | List of tags associated with the theme. |\n| data | shareConfigs | Array | Sharing configuration for the theme. |\n| data.shareConfigs | type | String | Sharing scope for the theme (for example, GLOBAL). |\n| errors | N/A | Array | List of errors encountered while processing the request. |\n| errors | id | String | Unique identifier associated with the error record. |\n| errors | code | Integer | Error code indicating the type of validation or lookup failure. |\n| errors | message | String | Detailed error message describing the issue. |\n\n### **Error Parameters**\n\n| **Parameter** | **Sub-parameter** | **Type** | **Description** |\n|----|----|----|----|\n| errors | id | String | Identifier associated with the error entry. |\n| errors | code | Integer | HTTP-style error code returned by the API (400, 404). |\n| errors | message | String | Human-readable error message describing the validation or lookup failure. |\n\n#### 9.10 Retrieve More Than 50 Themes\n\n**Request Parameters**\n\n| **Parameter** | **Sub-parameter** | **Required** | **Type** | **Description** |\n|----|----|----|----|----|\n| id | N/A | Yes | String | Comma-separated list of Listening Theme IDs to retrieve. A maximum of **50 theme identifiers** can be provided in a single request. Requests exceeding this limit return a validation error. |\n\n**Example Request**\n\ncurl --location --globoff '{{baseUrl}}/api/v3/listening/theme?id=id1%2Cid2%2Cid3%2Cid4%2Cid5%2Cid6%2Cid7%2Cid8%2Cid9%2Cid10%2Cid11%2Cid12%2Cid13%2Cid14%2Cid15%2Cid16%2Cid17%2Cid18%2Cid19%2Cid20%2Cid21%2Cid22%2Cid23%2Cid24%2Cid25%2Cid26%2Cid27%2Cid28%2Cid29%2Cid30%2Cid31%2Cid32%2Cid33%2Cid34%2Cid35%2Cid36%2Cid37%2Cid38%2Cid39%2Cid40%2Cid41%2Cid42%2Cid43%2Cid44%2Cid45%2Cid46%2Cid47%2Cid48%2Cid49%2Cid50%2Cid51' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}'\n\n**Example Response**\n\n{\n\n\"errors\": \\[\n\n{\n\n\"id\": \"6995b066f58d8b601be9ed44\",\n\n\"code\": 400,\n\n\"message\": \"Maximum of 50 listening_theme identifiers supported per request. Provided: 51. Consider splitting you request in batches of 50 identifiers per request\"\n\n}\n\n\\]\n\n}\n\n**Response Parameters**\n\n| **Parameter** | **Sub-parameter** | **Type** | **Description** |\n|----|----|----|----|\n| errors | N/A | Array | List of errors encountered while processing the request. |\n| errors | id | String | Unique identifier associated with the error record. |\n| errors | code | Integer | Error code indicating the type of validation failure. |\n| errors | message | String | Detailed error message describing the validation error and recommended resolution. |\n\n#### 9.11 Retrieve a Theme with Complete Sharing Configuration\n\n **Request Parameters**\n\n| **Parameter** | **Sub-parameter** | **Required** | **Type** | **Description** |\n|----|----|----|----|----|\n| id | N/A | Yes | String | Unique identifier of the Listening Theme to retrieve. Pass the Theme ID as a query parameter in the request URL |\n\n#### 9.12 **Example Request**\n```bash\ncurl --location '<{{baseUrl}}/api/v3/listening/theme?id=6995af98d7890350f0d74510>' \\\\\n\n--header 'Accept: application/json' \\\\\n\n--header 'Authorization: Bearer {{accessToken}}' \\\\\n\n--header 'Key: {{apiKey}}' \\\\\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"913-example-response","__idx":58},"children":["9.13 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\n\"data\": [\n\n{\n\n\"id\": \"6995af98d7890350f0d74510\",\n\n\"name\": \"Test-Theme-with-API\",\n\n\"displayName\": \"Test-Theme-with-API\",\n\n\"color\": \"#ca6969\",\n\n\"filters\": [\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"QUERY\",\n\n\"values\": [\n\n{\n\n\"orConditions\": [\n\n{\n\n\"topicKeywords\": [],\n\n\"operator\": \"AND\",\n\n\"keywordGroupsRef\": [\n\n{\n\n\"keywordGroupId\": \"67e657633d78d4090467b7e0\",\n\n\"operator\": \"AND\"\n\n}\n\n],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n],\n\n\"andConditions\": [\n\n{\n\n\"topicKeywords\": [],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": [\n\n{\n\n\"keywordGroupId\": \"6983038bdc0d4e0888a19de6\",\n\n\"operator\": \"OR\"\n\n}\n\n],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n],\n\n\"excludeConditions\": [\n\n{\n\n\"topicKeywords\": [\n\n{\n\n\"term\": \"black\",\n\n\"keywordType\": \"EXCLUDE_KEYWORD\",\n\n\"distance\": 0\n\n}\n\n],\n\n\"operator\": \"OR\",\n\n\"keywordGroupsRef\": [],\n\n\"ordered\": false,\n\n\"nearDistance\": 0\n\n}\n\n],\n\n\"textQuery\": \"(\\\\Rolex\\\\ AND (\\\\handcrafted clothing\\\\ OR \\\\artisan fashion\\\\ OR \\\\unique garments\\\\ OR \\\\fashion craftsmanship\\\\) AND NOT \\\\black\\\\)\",\n\n\"themesInQuery\": \\[\\]\n\n}\n\n\\],\n\n\"details\": {\n\n\"type\": \"criteria\"\n\n},\n\n\"filters\": \\[\\]\n\n},\n\n{\n\n\"filterType\": \"IN\",\n\n\"field\": \"POINT_RADIUS_LOCATION\",\n\n\"values\": \\[\n\n{\n\n\"type\": \"POINT_RADIUS\",\n\n\"locationName\": \"G33W+946 Ambience Island, DLF Phase 3, Sector 24, Gurugram, Haryana, India\",\n\n\"latitude\": 28.5034,\n\n\"longitude\": 77.0953,\n\n\"radius\": 10,\n\n\"unit\": \"mi\",\n\n\"id\": \"28.5034_77.0953\"\n\n}\n\n\\],\n\n\"details\": {},\n\n\"filters\": \\[\\]\n\n}\n\n\\],\n\n\"tags\": \\[\n\n\"Air Travel Preferences\",\n\n\"Credit Products - Retail Bank\"\n\n\\],\n\n\"shareConfigs\": \\[\n\n{\n\n\"type\": \"CLIENT\",\n\n\"ids\": \\[\n\n\"66000002\"\n\n\\]\n\n},\n\n{\n\n\"type\": \"CLIENT_GROUP\",\n\n\"ids\": \\[\n\n\"69956ee7bd0cf95d4a5b43a5\"\n\n\\]\n\n},\n\n{\n\n\"type\": \"USER\",\n\n\"ids\": \\[\n\n\"66006626\",\n\n\"66044670\",\n\n\"66044665\",\n\n\"66007863\",\n\n\"66044664\",\n\n\"66062939\",\n\n\"66044660\"\n\n\\]\n\n},\n\n{\n\n\"type\": \"USER_GROUP\",\n\n\"ids\": \\[\\]\n\n}\n\n\\]\n\n}\n\n\\],\n\n\"errors\": \\[\\]\n\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-4","__idx":59},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Listening Theme objects returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["displayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name of the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["color"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hex color code associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operator applied to the field. Example: IN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or field on which the filter is applied. Examples include QUERY and POINT_RADIUS_LOCATION."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of values used for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of OR conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["andConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of AND conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludeConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of exclusion conditions configured in the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["advanceQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced query expression used in the theme filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["textQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable representation of the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["themesInQuery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of referenced themes used within the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Topic keywords included in the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator applied to the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Referenced keyword groups used in the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordGroupId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the referenced keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.orConditions.keywordGroupsRef"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operator"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logical operator associated with the keyword group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["term"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Excluded keyword term."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywordType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of excluded keyword."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values.excludeConditions.topicKeywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["distance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distance value associated with the excluded keyword."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter configuration type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["raw_search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether raw search mode is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested filters associated with the current filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location filter type. Example: POINT_RADIUS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["locationName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the configured location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["latitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["longitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Double"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Longitude coordinate of the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["radius"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Radius around the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unit used for the radius."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.filters.values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the location filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags associated with the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing configuration for the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sharing scope (CLIENT, CLIENT_GROUP, USER, USER_GROUP, GLOBAL)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["data.shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of entities granted access to the theme."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["errors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of errors encountered during request processing. Returns an empty array when the request succeeds."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-patch-partially-update-a-listening-theme","__idx":60},"children":["10. PATCH: Partially Update a Listening Theme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Partially update a Listening Theme."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningThemeApiV3_patchTheme"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningThemePatchRequestDTO"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Declared errors."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 reference."]}," Update Theme 2.0, part of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/listening-2-0"},"children":["Listening 2.0"]}," suite."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ticket coverage."]}," **None.**Read/Fetch-scoped."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permission."]}," Conversations → Listening Settings → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit Theme"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"101-parameters","__idx":61},"children":["10.1 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":["required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening theme id"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note the description is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["singular"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Listening theme id\""]}," — with no mention of comma separation. Unlike ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," is single-target"]},": you can bulk-fetch and bulk-delete, but you must update Themes one at a time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"102-listening-theme-patch-request-dto","__idx":62},"children":["10.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Listening Theme Patch Request DTO"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema description: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Partial update for a Listening Theme.\""]}]},{"$$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":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description (from sprinklr-v3.yaml )"},"children":["Description (from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},")"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme display name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iconUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme icon url"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme image url"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Theme identification color"]}]},{"$$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":["array of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description"]}]},{"$$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":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tags"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShareConfig"]}]}," (single object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share configuration"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PermissionEntity"]}]}," (single object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permission configuration"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The schema declares no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array at all"]}," — every field is optional, which is consistent with partial-update semantics. It also means an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["empty body ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}," satisfies the schema"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required: false"]},", so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /listening/theme"]}," with an empty body is a spec-valid request with entirely undefined behaviour."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["absent from the body schema"]}," — the target travels only in the query string."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"103-share-config-and-permission-entity","__idx":63},"children":["10.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Share Config"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Permission Entity"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both are the V2-era shapes, and in V3 they have ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["identical property sets"]}," — the two schemas differ only in name and description."]},{"$$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":["userIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of integer (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of User IDs, which is unique identifier for each User"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userGroupIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of User Group IDs, which is unique identifier for each User Group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of integer (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Client IDs, which is unique identifier for Client"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientGroupIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of Client Group IDs, which is unique identifier for Client Group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareWithEveryOne"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set this true, in order to share with every User"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShareConfig"]}," is described as ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Describes the schema for Share Config\""]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PermissionEntity"]}," as ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Describes the schema for Permission\""]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Two things follow:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ids are numbers here, strings in create."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShareConfig.userIds"]}," is an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig.ids"]}," is an array of string. The same user id must be serialised as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["600000000"]}," in a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"600000000\""]}," in a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The V2 documentation understated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]},"."]}," The V2 Create Theme page documented ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]}," with only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userIds"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userGroupIds"]},". The V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PermissionEntity"]}," schema carries all five properties, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientIds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientGroupIds"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareWithEveryOne"]},". Whether the extra three are honoured on a permission entity, or simply inherited from a shared base class, is unknown."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unlike create, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," retains a direct equivalent of V2's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareWithEveryOne"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"104-filter_request--the-other-filter-schema","__idx":64},"children":["10.4 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," — the other filter schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," filters use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]},", which is substantially richer than the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," used on create:"]},{"$$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":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FilterType_Filter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enumerated"]}," — see below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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":["Field the filter applies to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompoundFilter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["negativeFilter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Negation. Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessibleValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userFilter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoed by the V2 create response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allValuesAllowed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoed by the V2 create response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lockedWithValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["favourite"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoed by the V2 create response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mandatory"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoed by the V2 create response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echoed by the V2 create response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ignoreAddingToDimensionFilter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Also in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$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":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recursive nesting."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advancedFilters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedFilterRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absent from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," here ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["is"]}," constrained, by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FilterType_Filter"]}," enum:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"FILTER · LIMIT · SEARCH · MATCH_PHRASE_PREFIX · ADHOC_SEARCH ·\nEXPRESSION · GEO_DISTANCE · ADVANCED_QUERY · MATCH_NONE · MATCH_ALL\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]}," — the only filter type evidenced anywhere for Themes — is not in this list."]}," So a filter that is valid on create may be rejected on patch. Unlike ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," has no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," on any property, so the meaning of the sixteen flags is undocumented."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because five of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]},"'s exclusive fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allValuesAllowed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["favourite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mandatory"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locked"]},") are exactly the keys the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 create response"]}," echoed back, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_request"]}," is very likely the true internal filter model, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," a reduced projection of it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"105-partial-update-semantics-are-undefined","__idx":65},"children":["10.5 Partial-update semantics are undefined"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The operation is named \"partial update\", but no source states how omitted or supplied collections are handled:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Omitted field"]}," — left unchanged (the normal ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," reading), or reset to null?"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supplied array (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},")"]}," — does it ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["replace"]}," the existing array wholesale, or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["merge"]}," with it?"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Empty array ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]}," — clears the collection, or is it a no-op?"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}]}," — does supplying it replace the whole share configuration, or merge id lists?"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]},", ETag, or version field on the entity, so ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["concurrent patches are last-write-wins"]}," with no optimistic-concurrency mechanism. The safest pattern is a serialised read-modify-write per Theme — but ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-patch-listeningtheme--partially-update-a-listening-theme"},"children":["§10 opening callout"]}," shows you cannot mechanically round-trip a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," body into a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," body, so you must translate the three divergent structures yourself."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"106-example-request","__idx":66},"children":["10.6 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PATCH \\\n 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=66badc8a6df5bf43f6c8f374' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"displayName\": \"Customer Service & Support\",\n \"description\": \"Customer service conversations, inquiries, and escalations\",\n \"color\": \"#2E7D32\",\n \"tags\": [\"cs\", \"support\", \"priority\", \"escalations\"],\n \"shareConfig\": {\n \"userIds\": [600000000, 600037831],\n \"userGroupIds\": [\"ug-support\"],\n \"shareWithEveryOne\": false\n },\n \"permissionEntity\": {\n \"userIds\": [600000000]\n }\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"107-response","__idx":67},"children":["10.7 Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response is declared as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]}]}," — a bare JSON string, not an object. No source states what it contains: the updated Theme's id, a status word such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCESS"]},", or a human-readable message."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consequences for your client:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["You cannot read the updated entity back from the response."]}," Issue a follow-up ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," if you need to confirm the result."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Do not parse the response as JSON into a model."]}," Treat a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," as success and the body as opaque."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the envelope described applies, the body may actually be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": \"…\", \"errors\": []}"]}," — in which case checking ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," remains essential."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"11-delete--delete-listening-themes","__idx":68},"children":["11. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," — Delete Listening Theme(s)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Delete Listening Theme(s) by id. Supports bulk delete."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 reference."]}," Delete Theme 2.0, part of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/listening-2-0"},"children":["Listening 2.0"]}," suite."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permission."]}," Conversations → Listening Settings → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete Theme"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"111-parameters","__idx":69},"children":["11.1 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":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated listening theme ids"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"112-bulk-delete","__idx":70},"children":["11.2 Bulk delete"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Single\ncurl -X DELETE \\\n 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=66badc8a6df5bf43f6c8f374' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}'\n\n# Bulk — comma-separated, no spaces\ncurl -X DELETE \\\n 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=66badc8a6df5bf43f6c8f374,60486cef06ebe67ed55c4140' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not put spaces after the commas; no source shows whitespace being tolerated, and an unencoded space is not valid in a query string."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Partial failure is unspecified."]}," If one id in a bulk delete does not exist, or the caller lacks permission on one of them, no source states whether the call is atomic (all-or-nothing), best-effort (deletes what it can), or fails outright. With a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]}," response body there is also no per-id result structure to report outcomes. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prefer deleting in small batches, or one at a time, when you need to know exactly what happened."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"113-response","__idx":71},"children":["11.3 Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," body is declared ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]}]}," with no described content. You cannot determine from the response how many Themes were actually deleted. Confirm with a follow-up ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," on the same ids and check that they no longer resolve."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"114-soft-delete-or-hard-delete","__idx":72},"children":["11.4 Soft delete or hard delete?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both the V2 create example and read example carry a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}," boolean"]}," on the Theme object, which strongly suggests the platform soft-deletes Themes rather than removing the record. But ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["absent from the V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," schema"]},", so a V3 client has no way to observe the flag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open questions this raises:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},", does a subsequent ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," on that id return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},", or return the object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted: true"]}," (a field your model does not have)?"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Can a deleted Theme be restored, and if so, by what call?"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Does the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," become reusable for a new Theme after deletion?"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None is answerable from the available sources."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"115-what-happens-to-things-that-reference-the-theme","__idx":73},"children":["11.5 What happens to things that reference the Theme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Theme is referenced from several places in the product — dashboard filters, widget dimensions, alert conditions, and rule conditions, all of which can target Themes via ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Theme Tags"]},". Read example also shows an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appliedToTopics"]}," array associating a Theme with Topics."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No source documents what deleting a Theme does to those references: whether the delete is blocked while references exist, whether references are silently dropped, or whether dashboards break. Because a Theme is a read-time lens rather than an ingestion rule, deleting one ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["cannot"]}," cause data loss in your mention store — but it can break saved dashboards and reporting that segment by it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended practice:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," the Theme and record its full definition before deleting, so it can be recreated if a dependency surfaces. There is no undo documented."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"12-v2--v3-migration","__idx":74},"children":["12. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"121-endpoint-mapping","__idx":75},"children":["12.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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change"},"children":["Change"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Theme (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-theme-2-0"},"children":["V2"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/listening-theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/listening/theme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Hyphenated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listening-theme"]}," becomes the nested path ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listening/theme"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read Theme"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/listening-theme/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/listening/theme?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Id moves path → query; gains bulk support."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Theme"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/listening-theme/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/listening/theme?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Method changes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"; id moves path → query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Theme"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v2/listening-theme/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/listening/theme?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Id moves path → query; gains bulk support."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["V2 read/update/delete path forms are inferred from the V2 suite's structure; only the create path is quoted verbatim from the V2 page."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This follows the V3 programme's consistent rewrite rule, seen across every entity documented so far: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["identifiers move from the path into query parameters, and hyphenated resource names become nested path segments."]}," A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v2"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v3"]}," string replacement will not work."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"122-the-create-body--what-changed","__idx":76},"children":["12.2 The create body — what changed"]},{"$$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 field"},"children":["V2 field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3 field"},"children":["V3 field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change"},"children":["Change"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged. Required in both."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iconUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iconUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$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":["Name unchanged. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type documentation changed"]}," — V2 documented it as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["List"]},", which its own example contradicts by sending objects. V3 correctly types it as an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]},"."]}]},{"$$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":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}," (object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}]}," (array)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]}," (object)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}]}," (array)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}," (in V2 example)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Removed."]}," Not in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]},". Drop it."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V2 page documented ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["List"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"The Filter list to filter out required data. List\""]}," — while its own example sends an array of objects. V3's typing is the correct one; if you built against the V2 documentation's stated type rather than its example, your code was already wrong."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"123-sharing-and-permissions-are-restructured-not-renamed","__idx":77},"children":["12.3 Sharing and permissions are restructured, not renamed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the largest breaking change and the easiest to get subtly wrong, because the V3 name ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}," is close enough to V2's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]}," to look like a simple rename. It is not."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 — two objects, four id lists each, keyed by id type:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"shareConfig\": {\n \"userIds\": [600000000],\n \"userGroupIds\": [\"ug-1\"],\n \"clientIds\": [66000002],\n \"clientGroupIds\": [\"cg-1\"],\n \"shareWithEveryOne\": false\n},\n\"permissionEntity\": {\n \"userIds\": [600000000],\n \"userGroupIds\": [\"ug-1\"]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3 — two arrays of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{type, ids}"]}," pairs:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"shareConfigs\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] },\n { \"type\": \"CLIENT\", \"ids\": [\"66000002\"] }\n],\n\"permissions\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\"] }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The model inverts: V2 keyed id lists by ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["field name"]},", V3 keys them by a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," discriminator"]},". Migration steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rename ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfig"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissionEntity"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]},", and change both from object to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Convert each V2 id list into an array element with the matching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userIds"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"type\": \"USER\", …}"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientIds"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"type\": \"CLIENT\", …}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Stringify all ids."]}," V2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userIds"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientIds"]}," were ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["List"]},"; V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," is an array of string."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Map ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareWithEveryOne: true"]}," to — most likely — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"type\": \"GLOBAL\"}"]},". ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unconfirmed"]},";"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Find the V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," values for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userGroupIds"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientGroupIds"]},". ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Not documented"]},";"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"124-what-else-to-check","__idx":78},"children":["12.4 What else to check"]},{"$$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":"Area"},"children":["Area"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Action"},"children":["Action"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": {…}, \"errors\": []}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Spec says bare object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unwrap defensively."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update method"]},{"$$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":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change the verb, and send partial bodies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bulk operations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One id per call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," accept comma-separated ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch reads and deletes."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter type value"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not in the patch enum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}," field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In the V2 example body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove from your payload."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host / env"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api3.sprinklr.com/{env}/…"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}.api.sprinklr.com/…"]}," per"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm with your account team."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"13-worked-examples","__idx":79},"children":["13. Worked examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["All examples are illustrative and reconstructed. Verify against your environment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"131-minimal-theme","__idx":80},"children":["13.1 Minimal Theme"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST 'https://api3.sprinklr.com/{env}/api/v3/listening/theme' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"name\": \"pricing_mentions\",\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n { \"advanceQuery\": \"pricing OR price OR cost\", \"textQuery\": \"pricing OR price OR cost\" }\n ]\n }\n ]\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"132-theme-reusing-an-existing-keyword-list","__idx":81},"children":["13.2 Theme reusing an existing Keyword List"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The pattern from the V2 page — reference a Keyword List by id rather than restating its keywords, so that updating the list updates every Theme that uses it."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST 'https://api3.sprinklr.com/{env}/api/v3/listening/theme' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"name\": \"competitor_mentions\",\n \"displayName\": \"Competitor Mentions\",\n \"description\": \"Mentions matching the maintained competitor keyword list\",\n \"color\": \"#E53935\",\n \"tags\": [\"competitive-intel\"],\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n {\n \"advanceQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\",\n \"textQuery\": \"keyword_list_or(\\\"5f601c2728cf4e53142af770\\\")\"\n }\n ]\n }\n ]\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"133-theme-shared-with-a-team-editable-by-two-users","__idx":82},"children":["13.3 Theme shared with a team, editable by two users"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST 'https://api3.sprinklr.com/{env}/api/v3/listening/theme' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"name\": \"customer_service\",\n \"displayName\": \"Customer Service\",\n \"color\": \"#4CAF50\",\n \"tags\": [\"cs\", \"support\"],\n \"filters\": [\n {\n \"filterType\": \"IN\",\n \"field\": \"QUERY\",\n \"values\": [\n { \"advanceQuery\": \"support OR help OR issue OR problem\", \"textQuery\": \"support OR help OR issue OR problem\" }\n ]\n }\n ],\n \"shareConfigs\": [\n { \"type\": \"CLIENT\", \"ids\": [\"66000002\"] }\n ],\n \"permissions\": [\n { \"type\": \"USER\", \"ids\": [\"600000000\", \"600037831\"] }\n ]\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"134-create-then-read-back--the-recommended-verification-loop","__idx":83},"children":["13.4 Create then read back — the recommended verification loop"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# 1. Create, capturing the id\nTHEME_ID=$(curl -s -X POST 'https://api3.sprinklr.com/{env}/api/v3/listening/theme' \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' \\\n -H 'Content-Type: application/json' \\\n -d @theme.json | python3 -c 'import sys,json; r=json.load(sys.stdin); d=r.get(\"data\", r); d=d[0] if isinstance(d,list) else d; print(d[\"id\"])')\n\n# 2. Read it back\ncurl -s -X GET \"https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=${THEME_ID}\" \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' | python3 -m json.tool\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The id extraction above handles all three candidate response shapes from."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"135-bulk-read-and-bulk-delete","__idx":84},"children":["13.5 Bulk read and bulk delete"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Read several Themes in one call\ncurl -X GET 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=60486cef06ebe67ed55c4140,66badc8a6df5bf43f6c8f374' \\\n -H 'Authorization: Bearer {{accessToken}}' -H 'Key: {{apiKey}}'\n\n# Delete several — always with an explicit id list\ncurl -X DELETE 'https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=60486cef06ebe67ed55c4140,66badc8a6df5bf43f6c8f374' \\\n -H 'Authorization: Bearer {{accessToken}}' -H 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"14-use-cases","__idx":85},"children":["14. Use cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Four patterns that combine the four operations. All are illustrative."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"141-provision-a-theme-taxonomy-across-environments","__idx":86},"children":["14.1 Provision a Theme taxonomy across environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The most common reason to reach for this API. Keep Theme definitions in version control, then apply them per environment."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store one JSON file per Theme, each a valid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ListeningTheme"]}," create body, with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," as the stable key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For each file, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," it and record the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," in an environment-scoped map (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On a later run, look the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," up in the map: if present, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," by its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"; if absent, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because there is no documented list-all or name-search on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," , ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," map is the only index you have."]}," Persist it as a build artefact; if you lose it, you cannot reliably rediscover which Themes you own. This is the strongest practical argument for treating id storage as part of the deployment, not a cache."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remember that the create and patch bodies are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not interchangeable"]}," — keep a translation function between the two shapes rather than reusing one payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"142-mirror-an-external-taxonomy","__idx":87},"children":["14.2 Mirror an external taxonomy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sync Themes from a product catalogue, CRM category tree, or support-ticket schema."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read the external taxonomy."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," your known Theme ids in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one bulk call"]}," — comma-separate them rather than looping."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Diff on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},": create the additions, patch the changes, and collect the removals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delete the removals in a single bulk ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},", having first ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},"-ed and archived their full definitions."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tag every Theme created by the sync with a common tag — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"tags\": [\"src:crm\"]"]}," — so automation-owned Themes are distinguishable from hand-built ones in the UI."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"143-audit-and-back-up-theme-configuration","__idx":88},"children":["14.3 Audit and back up Theme configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bulk ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," makes this cheap, and it is the safest operation in the set."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -s -X GET \"https://api3.sprinklr.com/{env}/api/v3/listening/theme?id=${IDS}\" \\\n -H 'Authorization: Bearer {{accessToken}}' \\\n -H 'Key: {{apiKey}}' > themes-$(date +%Y%m%d).json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," return only an opaque string and there is no version history on the entity, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["a periodic snapshot is your only rollback mechanism."]}," Run it before any bulk change."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"144-roll-out-a-segment-across-many-topics","__idx":89},"children":["14.4 Roll out a segment across many Topics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create one Theme per product attribute, region, or campaign, then apply it consistently."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Build the filter once in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UI Theme Editor"]},", using its live preview to validate that the query returns what you expect — there is no API dry-run."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," that Theme and copy its exact ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," block."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate the remaining Themes programmatically, substituting only the keyword or keyword-list id."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Give them all a shared tag so dashboards, widgets, alerts, and rules can target the whole family at once."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the recommended way to work around the filter-vocabulary uncertainty in: let the UI produce a known-good filter, then replicate its shape rather than inventing one."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"15-caveats-and-best-practices","__idx":90},"children":["15. Caveats and best practices"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"151-treat-every-write-path-as-unverified","__idx":91},"children":["15.1 Treat every write path as unverified"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," have ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no ticket coverage and no recorded production verification"]}," in any available source. Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," is signed off. Before running writes at volume:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Exercise each operation once in a non-production environment and record the actual request and response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Diff the created object against what you sent to learn the server's defaulting behaviour."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep that transcript — it is better evidence than this guide."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"152-never-issue-an-unparameterised-delete","__idx":92},"children":["15.2 Never issue an unparameterised ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Restating the most dangerous item on the page: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /listening/theme"]}," declares its only targeting parameter as optional, and it is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["bulk"]}," operation (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#111-parameters"},"children":["§11.1"]},"). Validate a non-empty id list ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["client-side"]}," before the URL is built. Do not rely on the server to reject an empty target."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"153-do-not-round-trip-get-into-patch","__idx":93},"children":["15.3 Do not round-trip ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," into ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The fetch response, the create body, and the patch body use three different structures for filters, sharing, and permissions (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#01-the-most-important-thing-on-this-page"},"children":["§0.1"]},"). Write an explicit translation layer with tests. A naive read-modify-write will either fail validation or, worse, silently drop the fields it does not recognise."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Watch the id types especially: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["strings"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig.ids"]}," on create, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["numbers"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ShareConfig.userIds"]}," on patch."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"154-parse-responses-permissively","__idx":94},"children":["15.4 Parse responses permissively"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Given the schema/example divergence in , configure your JSON deserialiser to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ignore unknown properties"]},", and do not fail if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," arrives as an object rather than an array. Unwrap a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," envelope if present, and read the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array even on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"155-let-the-ui-author-your-filters","__idx":95},"children":["15.5 Let the UI author your filters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_shifu"]}," has no enum on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]},", and the only evidenced values come from a V2 example whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType: \"IN\""]}," is absent from the enum the patch schema uses. Building filter JSON from first principles is guesswork. Build in the Theme Editor, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},", and copy."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"156-batch-reads-and-deletes-but-not-blindly","__idx":96},"children":["15.6 Batch reads and deletes, but not blindly"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," accept comma-separated ids; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," does not. Batching cuts call volume, but no source states a maximum id count or how partial failures are reported. Start with modest batches — tens, not thousands — and reduce them if you see ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"s. When you need to know exactly which ids succeeded, delete one at a time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"157-assume-rate-limits-exist-even-though-none-are-declared","__idx":97},"children":["15.7 Assume rate limits exist even though none are declared"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Neither ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," nor ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," is declared on any operation in this tag. That is a documentation gap, not a guarantee of unlimited throughput. Implement exponential backoff with jitter, honour ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," if present, and throttle bulk provisioning rather than firing it in parallel."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"158-creating-a-theme-cannot-lose-you-data","__idx":98},"children":["15.8 Creating a Theme cannot lose you data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Worth stating plainly, because it makes Themes far safer to automate than Topics. A Theme is a read-time lens over already-ingested data , so creating, changing, or deleting one ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["never changes ingestion volume or your data bill."]}," The blast radius of a mistake is broken dashboards and reporting — recoverable — not lost mentions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The one caveat: whether a new Theme applies retroactively to already-collected mentions or only forward from creation is undocumented."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"159-tag-deliberately-at-creation-time","__idx":99},"children":["15.9 Tag deliberately at creation time"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Theme Tags are how dashboards, widgets, alerts, and rules address groups of Themes. Assigning them at create time costs nothing; retrofitting them means a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," per Theme, since patch is single-target. Decide your tag vocabulary before you provision."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1510-store-ids-and-store-them-durably","__idx":100},"children":["15.10 Store ids, and store them durably"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no documented list-all, name search, or pagination on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET. The "]},"id",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["returned from"]},"POST` may be the only handle you ever get. Persist it at creation time."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Create Listening Theme — API V3 Developer Guide","id":"create-listening-theme--api-v3-developer-guide","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 What a Listening Theme is","id":"11-what-a-listening-theme-is","depth":3},{"value":"1.2 Where a Theme sits in the Listening model","id":"12-where-a-theme-sits-in-the-listening-model","depth":3},{"value":"1.3 When to use the API instead of the UI","id":"13-when-to-use-the-api-instead-of-the-ui","depth":3},{"value":"1.4 Conventions in this guide","id":"14-conventions-in-this-guide","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. POST: Create Listening Theme","id":"4-post-create-listening-theme","depth":2},{"value":"4.1 Parameters","id":"41-parameters","depth":3},{"value":"4.2 Required fields","id":"42-required-fields","depth":3},{"value":"4.3 Example request","id":"43-example-request","depth":3},{"value":"4.4 Example response","id":"44-example-response","depth":3},{"value":"5. The ListeningTheme object","id":"5-the-listeningtheme-object","depth":2},{"value":"5.1 Name versus DisplayName","id":"51-name-versus-displayname","depth":3},{"value":"5.2 Tags","id":"52-tags","depth":3},{"value":"5.3 Color , IconUrl , Image Url","id":"53-color--iconurl--image-url","depth":3},{"value":"6. Filters","id":"6-filters","depth":2},{"value":"6.1 Filter_shifu schema","id":"61-filter_shifu-schema","depth":3},{"value":"6.2 The values that actually work","id":"62-the-values-that-actually-work","depth":3},{"value":"6.3 The enum that exists but does not apply","id":"63-the-enum-that-exists-but-does-not-apply","depth":3},{"value":"6.4 Nested filters","id":"64-nested-filters","depth":3},{"value":"6.5 Location-based Themes","id":"65-location-based-themes","depth":3},{"value":"7. Sharing and permissions","id":"7-sharing-and-permissions","depth":2},{"value":"7.1 AssetShareConfig","id":"71-assetshareconfig","depth":3},{"value":"7.2 Sharing with everyone","id":"72-sharing-with-everyone","depth":3},{"value":"7.3 Id types changed","id":"73-id-types-changed","depth":3},{"value":"8. Response format and status codes","id":"8-response-format-and-status-codes","depth":2},{"value":"8.1 The envelope question","id":"81-the-envelope-question","depth":3},{"value":"8.2 Declared status codes","id":"82-declared-status-codes","depth":3},{"value":"8.3 Error responses","id":"83-error-responses","depth":3},{"value":"9. GET: Fetch Listening Themes","id":"9-get-fetch-listening-themes","depth":2},{"value":"9.1 Parameters","id":"91-parameters","depth":3},{"value":"9.2 Bulk fetch","id":"92-bulk-fetch","depth":3},{"value":"9.3 Example response","id":"93-example-response","depth":3},{"value":"9.4 The response example does not match the schema","id":"94-the-response-example-does-not-match-the-schema","depth":3},{"value":"9.5 Verified GET scenarios","id":"95-verified-get-scenarios","depth":3},{"value":"9.5.1 Retrieve a Theme by ID: Basic Response","id":"951-retrieve-a-theme-by-id-basic-response","depth":4},{"value":"Example Request","id":"example-request","depth":4},{"value":"Example Response","id":"example-response","depth":4},{"value":"Response Parameters","id":"response-parameters","depth":4},{"value":"9.6 Retrieve a Theme by ID: Additional Basic Response","id":"96-retrieve-a-theme-by-id-additional-basic-response","depth":4},{"value":"Example Request","id":"example-request-1","depth":4},{"value":"Request Parameters","id":"request-parameters","depth":4},{"value":"Example Response","id":"example-response-1","depth":4},{"value":"Response Parameters","id":"response-parameters-1","depth":4},{"value":"9.7 Retrieve a Theme by ID: Complex Filters","id":"97-retrieve-a-theme-by-id-complex-filters","depth":4},{"value":"Example Request","id":"example-request-2","depth":4},{"value":"Example Response","id":"example-response-2","depth":4},{"value":"Response Parameters","id":"response-parameters-2","depth":4},{"value":"9.8 Retrieve Multiple Themes: All Found","id":"98-retrieve-multiple-themes-all-found","depth":4},{"value":"Example Request","id":"example-request-3","depth":4},{"value":"Example Response","id":"example-response-3","depth":4},{"value":"Response Parameters","id":"response-parameters-3","depth":4},{"value":"9.9 Retrieve Multiple Themes: Partial Success","id":"99-retrieve-multiple-themes-partial-success","depth":4},{"value":"Example Request","id":"example-request-4","depth":4},{"value":"Example Response","id":"example-response-4","depth":4},{"value":"9.13 Example Response","id":"913-example-response","depth":4},{"value":"Response Parameters","id":"response-parameters-4","depth":4},{"value":"10. PATCH: Partially Update a Listening Theme","id":"10-patch-partially-update-a-listening-theme","depth":2},{"value":"10.1 Parameters","id":"101-parameters","depth":3},{"value":"10.2 Listening Theme Patch Request DTO","id":"102-listening-theme-patch-request-dto","depth":3},{"value":"10.3 Share Config and Permission Entity","id":"103-share-config-and-permission-entity","depth":3},{"value":"10.4 Filter_request — the other filter schema","id":"104-filter_request--the-other-filter-schema","depth":3},{"value":"10.5 Partial-update semantics are undefined","id":"105-partial-update-semantics-are-undefined","depth":3},{"value":"10.6 Example request","id":"106-example-request","depth":3},{"value":"10.7 Response","id":"107-response","depth":3},{"value":"11. DELETE — Delete Listening Theme(s)","id":"11-delete--delete-listening-themes","depth":2},{"value":"11.1 Parameters","id":"111-parameters","depth":3},{"value":"11.2 Bulk delete","id":"112-bulk-delete","depth":3},{"value":"11.3 Response","id":"113-response","depth":3},{"value":"11.4 Soft delete or hard delete?","id":"114-soft-delete-or-hard-delete","depth":3},{"value":"11.5 What happens to things that reference the Theme","id":"115-what-happens-to-things-that-reference-the-theme","depth":3},{"value":"12. V2 → V3 migration","id":"12-v2--v3-migration","depth":2},{"value":"12.1 Endpoint mapping","id":"121-endpoint-mapping","depth":3},{"value":"12.2 The create body — what changed","id":"122-the-create-body--what-changed","depth":3},{"value":"12.3 Sharing and permissions are restructured, not renamed","id":"123-sharing-and-permissions-are-restructured-not-renamed","depth":3},{"value":"12.4 What else to check","id":"124-what-else-to-check","depth":3},{"value":"13. Worked examples","id":"13-worked-examples","depth":2},{"value":"13.1 Minimal Theme","id":"131-minimal-theme","depth":3},{"value":"13.2 Theme reusing an existing Keyword List","id":"132-theme-reusing-an-existing-keyword-list","depth":3},{"value":"13.3 Theme shared with a team, editable by two users","id":"133-theme-shared-with-a-team-editable-by-two-users","depth":3},{"value":"13.4 Create then read back — the recommended verification loop","id":"134-create-then-read-back--the-recommended-verification-loop","depth":3},{"value":"13.5 Bulk read and bulk delete","id":"135-bulk-read-and-bulk-delete","depth":3},{"value":"14. Use cases","id":"14-use-cases","depth":2},{"value":"14.1 Provision a Theme taxonomy across environments","id":"141-provision-a-theme-taxonomy-across-environments","depth":3},{"value":"14.2 Mirror an external taxonomy","id":"142-mirror-an-external-taxonomy","depth":3},{"value":"14.3 Audit and back up Theme configuration","id":"143-audit-and-back-up-theme-configuration","depth":3},{"value":"14.4 Roll out a segment across many Topics","id":"144-roll-out-a-segment-across-many-topics","depth":3},{"value":"15. Caveats and best practices","id":"15-caveats-and-best-practices","depth":2},{"value":"15.1 Treat every write path as unverified","id":"151-treat-every-write-path-as-unverified","depth":3},{"value":"15.2 Never issue an unparameterised DELETE","id":"152-never-issue-an-unparameterised-delete","depth":3},{"value":"15.3 Do not round-trip GET into PATCH","id":"153-do-not-round-trip-get-into-patch","depth":3},{"value":"15.4 Parse responses permissively","id":"154-parse-responses-permissively","depth":3},{"value":"15.5 Let the UI author your filters","id":"155-let-the-ui-author-your-filters","depth":3},{"value":"15.6 Batch reads and deletes, but not blindly","id":"156-batch-reads-and-deletes-but-not-blindly","depth":3},{"value":"15.7 Assume rate limits exist even though none are declared","id":"157-assume-rate-limits-exist-even-though-none-are-declared","depth":3},{"value":"15.8 Creating a Theme cannot lose you data","id":"158-creating-a-theme-cannot-lose-you-data","depth":3},{"value":"15.9 Tag deliberately at creation time","id":"159-tag-deliberately-at-creation-time","depth":3},{"value":"15.10 Store ids, and store them durably","id":"1510-store-ids-and-store-them-durably","depth":3}],"frontmatter":{"seo":{"title":"Create Listening Theme — API V3 Developer Guide"}},"lastModified":"2026-10-16T02:18:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/topics/listening-theme-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}