---
updatedAt: 2026-06-11T21:07:31.000Z
agentTools:
  projectIndex: https://docs.constructor.com/llms.txt
---

# Create or update searchabilities (Deprecated)

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `searchabilities(w)`.

Create or update searchabilities.

<Callout icon="🚧">
  The Searchabilities API has been upgraded to v2. See the [Facets and Searchabilities v2 migration guide](https://docs.constructor.com/reference/configuration-facets-and-searchabilities-v2-migration-guide) for what's changing and how to migrate.
</Callout>

***

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "email": "support@constructor.io"
    },
    "title": "Configuration",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://ac.cnstrc.com"
    }
  ],
  "security": [],
  "tags": [
    {
      "name": "Searchabilities"
    }
  ],
  "paths": {
    "/v1/searchabilities": {
      "patch": {
        "deprecated": true,
        "tags": [
          "Searchabilities"
        ],
        "operationId": "v1-searchabilities-create-or-update-searchabilities",
        "summary": "Create or update searchabilities (Deprecated)",
        "description": "**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**\nFor authenticating with Bearer token, required scopes are: `searchabilities(w)`.\n\nCreate or update searchabilities.",
        "parameters": [
          {
            "name": "key",
            "in": "query",
            "schema": {
              "title": "Key",
              "description": "The key of the index to use.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "key_K2pX7vBnU0bgA5xp"
              ],
              "type": "string"
            },
            "required": true
          },
          {
            "name": "section",
            "in": "query",
            "schema": {
              "title": "Section",
              "description": "The section of the index to use. Defaults to `Products`.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "Products",
                "Search Suggestions"
              ],
              "type": "string"
            },
            "required": false
          },
          {
            "name": "c",
            "in": "query",
            "schema": {
              "title": "C",
              "description": "The ID of the client and version that the request is coming from, such as `cio-js-2.90`.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "cio-js-2.90",
                "cio-ios-1.0"
              ],
              "type": "string"
            },
            "required": false
          },
          {
            "name": "skip_rebuild",
            "in": "query",
            "schema": {
              "title": "Skip Rebuild",
              "description": "Skip index rebuild.",
              "default": false,
              "examples": [
                false,
                true
              ],
              "type": "boolean"
            },
            "required": false
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchabilityListPatchRequestBody"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchabilityListPatchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error"
          },
          "401": {
            "description": "Credentials are not passed or action is forbidden."
          },
          "403": {
            "description": "The supplied token does not have the required permissions."
          },
          "429": {
            "description": "Rate limit breached"
          }
        },
        "security": [
          {
            "http_basic_auth": []
          },
          {
            "http_bearer_auth": [
              "searchabilities(w)"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "MetadataSearchabilityType": {
        "title": "MetadataSearchabilityType",
        "enum": [
          "number",
          "string",
          "array",
          "object",
          "boolean",
          "mixed"
        ],
        "type": "string"
      },
      "SearchabilityResponse": {
        "title": "SearchabilityResponse",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "description": "Name of searchability field.",
            "maxLength": 300,
            "minLength": 1,
            "type": "string"
          },
          "percentage_presence": {
            "title": "Percentage presence",
            "description": "Percentage of items and variations that contain this field.",
            "minimum": 0,
            "maximum": 100,
            "type": "number"
          },
          "fuzzy_searchable": {
            "title": "Fuzzy Searchable",
            "description": "Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.",
            "type": "boolean"
          },
          "facetable": {
            "title": "Facetable",
            "description": "Specifies whether the field should be treated as a facet. When True, the metadata field must be a string, float, integer, or list of these types. Dictionaries are supported if they contain values of these types. Nested dictionaries are not supported",
            "type": "boolean"
          },
          "exact_searchable": {
            "title": "Exact Searchable",
            "description": "Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.",
            "type": "boolean"
          },
          "type": {
            "title": "Type",
            "allOf": [
              {
                "$ref": "#/components/schemas/MetadataSearchabilityType"
              }
            ]
          },
          "example_items": {
            "title": "Example Items",
            "description": "A list of items that has this searchability field.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "default": {
            "title": "Default",
            "description": "Flag that shows if this searchability config is default.",
            "type": "boolean"
          },
          "displayable": {
            "title": "Displayable",
            "description": "Specifies whether the field is displayable in the response within the `results` array.",
            "type": "boolean"
          },
          "hidden": {
            "title": "Hidden",
            "description": "Hides the field by default in the response but makes it available to retrieve via `fmt_options[hidden_fields]` parameter.",
            "type": "boolean"
          },
          "created_at": {
            "title": "Created At",
            "description": "Creation date and time",
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "title": "Updated At",
            "description": "Last updated date and time",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "name",
          "fuzzy_searchable",
          "facetable",
          "exact_searchable",
          "default",
          "displayable",
          "hidden",
          "created_at"
        ],
        "additionalProperties": false
      },
      "SearchabilityListPatchRequestBody": {
        "title": "SearchabilityListPatchRequestBody",
        "type": "object",
        "properties": {
          "searchabilities": {
            "title": "Searchabilities",
            "description": "A list of facet searchabilities configurations for create or update.",
            "minItems": 1,
            "maxItems": 60,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchabilityWithNameRequest",
              "examples": [
                [
                  {
                    "name": "brand",
                    "fuzzy_searchable": true,
                    "displayable": true
                  },
                  {
                    "name": "color",
                    "facetable": true,
                    "displayable": true
                  }
                ]
              ]
            }
          }
        },
        "required": [
          "searchabilities"
        ],
        "additionalProperties": false
      },
      "SearchabilityWithNameRequest": {
        "title": "SearchabilityWithNameRequest",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "description": "Name of searchability field.",
            "maxLength": 300,
            "minLength": 1,
            "examples": [
              "brand",
              "color",
              "price"
            ],
            "type": "string"
          },
          "fuzzy_searchable": {
            "title": "Fuzzy Searchable",
            "description": "Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "exact_searchable": {
            "title": "Exact Searchable",
            "description": "Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.",
            "examples": [
              false,
              true
            ],
            "type": "boolean"
          },
          "facetable": {
            "title": "Facetable",
            "description": "Specifies whether the field should be treated as a facet. When True, the metadata field must be a string, float, integer, or list of these types. Dictionaries are supported if they contain values of these types. Nested dictionaries are not supported",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "displayable": {
            "title": "Displayable",
            "description": "Specifies whether the field is displayable in the response within the `results` array.",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "hidden": {
            "title": "Hidden",
            "description": "Hides the field by default in the response but makes it available to retrieve via `fmt_options[hidden_fields]` parameter.",
            "examples": [
              false,
              true
            ],
            "type": "boolean"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      },
      "SearchabilityListPatchResponse": {
        "title": "SearchabilityListPatchResponse",
        "type": "object",
        "properties": {
          "searchabilities": {
            "title": "Searchabilities",
            "description": "A list of facet searchabilities configurations.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchabilityResponse"
            }
          },
          "total_count": {
            "title": "Total Count",
            "description": "Number of searchabilities.",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "searchabilities",
          "total_count"
        ],
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "http_basic_auth": {
        "type": "http",
        "scheme": "basic"
      },
      "http_bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```