Update Spotlight Query

Updates a query.

put

Path parameters

idstringRequired

id of entity

Body

application/jsontext/jsonapplication/*+json

namestringOptional

templatestringOptional

rqlFilterstringOptional

scopestringOptional

moduleIdstringOptional

moduleCodestringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /public/v1/spotlight/queries/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "text",
  "template": "text",
  "rqlFilter": "text",
  "scope": "text",
  "moduleId": "text",
  "moduleCode": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-20T12:34:26.850Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-20T12:34:26.850Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "template": "text",
  "invalidationInterval": "text",
  "invalidateOnDateChange": true,
  "filter": "text",
  "scope": "text"
}