Update searchable attributes

PUT /indexes/{indexUid}/settings/searchable-attributes
Api key

Update the searchable attributes of an index.


If the provided index does not exist, it will be created.

Headers

  • Content-Type string Required

    Payload content-type

    Value is application/json.

Path parameters

  • indexUid string Required

    Index Unique Identifier

application/json

Body Required

array[string] array[string]

Fields in which to search for matching query words sorted by order of importance.

Responses

  • • 202 application/json

    Accepted

  • • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • • 404

    Not Found

PUT /indexes/{indexUid}/settings/searchable-attributes 
curl \
 -X PUT https://example.meilisearch.com:7700/indexes/movies/settings/searchable-attributes \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '["title","description","genre"]'
Request example 
# Headers
Content-Type: application/json

# Payload
[
  "title",
  "description",
  "genre"
]
Response examples (202) 
{
  "taskUid": 0,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-01-01T09:39:00.000000Z"
}
Response examples (401) 
{
  "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"
}