Skip to content

Update Search Term

Updates an existing search term — the Edit action on the admin Marketing → Search & SEO → Search Terms screen. Only the term text and redirect URL are editable; the result count and use count are recorded by the storefront and cannot be changed here.

TIP

New here? Read the Search Terms overview for what a search term is and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/search-terms/{id}PUT

Details

  • Requires an admin Bearer token and the marketing.search_seo.search_terms.edit permission.
  • results and uses are storefront-recorded and not editable.
  • Returns the full updated search-term payload.
  • An unknown id returns a 404.

Request body

FieldTypeRequiredNotes
termstringyesThe search term text
redirect_urlstringnoA valid URL to redirect this query to, or null

Released under the MIT License.