cURL
curl \
-X PATCH 'MEILISEARCH_URL/dynamic-search-rules/black-friday' \
-H 'Content-Type: application/json' \
--data-binary '{
"description": "Black Friday 2025 rules",
"precedence": 10,
"active": true,
"conditions": {
"query": {
"isEmpty": true
},
"time": {
"start": "2025-11-28T00:00:00Z",
"end": "2025-11-28T23:59:59Z"
}
},
"actions": [
{
"selector": { "indexUid": "products", "id": "123" },
"action": { "type": "pin", "position": 1 }
}
]
}'import requests
url = "http://localhost:7700/dynamic-search-rules/{uid}"
payload = {
"description": "<string>",
"precedence": 1,
"active": True,
"conditions": {
"time": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"query": {
"isEmpty": True,
"words": "<string>"
},
"filter": { "values": {} }
},
"actions": [
{
"selector": {
"id": "<string>",
"indexUid": "movies"
},
"action": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
precedence: 1,
active: true,
conditions: {
time: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
query: {isEmpty: true, words: '<string>'},
filter: {values: {}}
},
actions: [{selector: {id: '<string>', indexUid: 'movies'}, action: {}}]
})
};
fetch('http://localhost:7700/dynamic-search-rules/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/dynamic-search-rules/{uid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'precedence' => 1,
'active' => true,
'conditions' => [
'time' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'query' => [
'isEmpty' => true,
'words' => '<string>'
],
'filter' => [
'values' => [
]
]
],
'actions' => [
[
'selector' => [
'id' => '<string>',
'indexUid' => 'movies'
],
'action' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:7700/dynamic-search-rules/{uid}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:7700/dynamic-search-rules/{uid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7700/dynamic-search-rules/{uid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"taskUid": 147,
"indexUid": null,
"status": "enqueued",
"type": "dsrUpdate",
"enqueuedAt": "2024-08-08T17:05:55.791772Z"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Search Rules
Create or update a search rule
Partially update a search rule by replacing the provided fields. If the rule doesn’t exist, it will be created.
PATCH
/
dynamic-search-rules
/
{uid}
cURL
curl \
-X PATCH 'MEILISEARCH_URL/dynamic-search-rules/black-friday' \
-H 'Content-Type: application/json' \
--data-binary '{
"description": "Black Friday 2025 rules",
"precedence": 10,
"active": true,
"conditions": {
"query": {
"isEmpty": true
},
"time": {
"start": "2025-11-28T00:00:00Z",
"end": "2025-11-28T23:59:59Z"
}
},
"actions": [
{
"selector": { "indexUid": "products", "id": "123" },
"action": { "type": "pin", "position": 1 }
}
]
}'import requests
url = "http://localhost:7700/dynamic-search-rules/{uid}"
payload = {
"description": "<string>",
"precedence": 1,
"active": True,
"conditions": {
"time": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"query": {
"isEmpty": True,
"words": "<string>"
},
"filter": { "values": {} }
},
"actions": [
{
"selector": {
"id": "<string>",
"indexUid": "movies"
},
"action": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
precedence: 1,
active: true,
conditions: {
time: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
query: {isEmpty: true, words: '<string>'},
filter: {values: {}}
},
actions: [{selector: {id: '<string>', indexUid: 'movies'}, action: {}}]
})
};
fetch('http://localhost:7700/dynamic-search-rules/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/dynamic-search-rules/{uid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'precedence' => 1,
'active' => true,
'conditions' => [
'time' => [
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z'
],
'query' => [
'isEmpty' => true,
'words' => '<string>'
],
'filter' => [
'values' => [
]
]
],
'actions' => [
[
'selector' => [
'id' => '<string>',
'indexUid' => 'movies'
],
'action' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:7700/dynamic-search-rules/{uid}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:7700/dynamic-search-rules/{uid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7700/dynamic-search-rules/{uid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"precedence\": 1,\n \"active\": true,\n \"conditions\": {\n \"time\": {\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\"\n },\n \"query\": {\n \"isEmpty\": true,\n \"words\": \"<string>\"\n },\n \"filter\": {\n \"values\": {}\n }\n },\n \"actions\": [\n {\n \"selector\": {\n \"id\": \"<string>\",\n \"indexUid\": \"movies\"\n },\n \"action\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"taskUid": 147,
"indexUid": null,
"status": "enqueued",
"type": "dsrUpdate",
"enqueuedAt": "2024-08-08T17:05:55.791772Z"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({ host: 'MEILISEARCH_URL', apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1' });
Path Parameters
Unique identifier of the search rule.
Body
application/json
Human-readable description of the dynamic search rule.
Precedence of the dynamic search rule. Lower numeric values take precedence over higher ones. If omitted, the rule is treated as having the lowest precedence. This precedence is used to resolve conflicts between matching rules:
- If the same document is selected by multiple rules, the smallest
prioritynumber wins - If different documents are pinned to the same position, they are ordered by ascending
priority
Required range:
x >= 0Whether the dynamic search rule is active.
Conditions that must match before the dynamic search rule applies.
Show child attributes
Show child attributes
Actions to apply when the dynamic search rule matches.
Show child attributes
Show child attributes
Response
Task enqueued to update dynamic search rule.
A summarized view of a task, returned when a task is enqueued
Unique sequential identifier of the task.
Required range:
x >= 0Status of the task. Possible values are enqueued, processing,
succeeded, failed, and canceled.
Available options:
enqueued, processing, succeeded, failed, canceled Example:
"processing"
Type of operation performed by the task.
Available options:
documentAdditionOrUpdate, documentEdition, documentDeletion, settingsUpdate, indexCreation, indexDeletion, indexUpdate, indexSwap, taskCancelation, taskDeletion, dumpCreation, snapshotCreation, export, upgradeDatabase, indexCompaction, networkTopologyChange, dsrUpdate, dsrClear Example:
"documentAdditionOrUpdate"
Date and time when the task was enqueued.
Unique identifier of the targeted index. Null for global tasks.
Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.
Was this page helpful?