Update a search profile

Partial update of any profile field. Every field is optional. Rejects a slug collision with another profile on the same site with 400.

Required permissions
search.profiles.update
PUT/search/profiles/{id}
Base URLhttps://api.lynkow.com/v1

Path parameters

id
string
required

Unique identifier

Request body
required

  • name
    string

    Display name. 1-200 characters

  • slug
    string

    URL-friendly identifier, unique per site and locale. 1-100 characters

  • sort
    array<string>

    Max 10 characters. Array of strings

  • scope
    object
    • excludeIds
      array<string>
    • includeIds
      array<string>
    • excludeTags
      array<string>
    • includeTags
      array<string>
    • metaFilters
      array<object>
      • op
        enum
        required

        One of: =!=innotIn

      • key
        string
        required
      • value
        any
    • excludeTypes
      array<string>
    • includeTypes
      array<string>
    • excludeLocales
      array<string>
    • includeLocales
      array<string>
    • excludeCategories
      array<string>
    • includeCategories
      array<string>
    • includePathPrefixes
      array<string>
  • facets
    array<string>

    Max 20 characters. Array of strings

  • isPublic
    boolean

    Whether this search profile is exposed on the public storefront search API. Boolean

  • maxLimit
    number

    Between 1 and 500

  • description
    union

    Description text

  • defaultLimit
    number

    Between 1 and 100

  • displayedFields
    array<string>

    Min 1 character. Array of strings

  • searchableFields
    array<enum>

    Min 1 character. Array of strings

  • boostedContentIds
    array<string>

    Content UUIDs to rank higher in results (max 100). Max 100 characters. Array of strings

  • featuredContentIds
    array<string>

    Content UUIDs pinned to the top of results regardless of relevance (max 100). Max 100 characters. Array of strings

Feedback

Was this page helpful?