Skip to content

Update Search Term

Updates an existing search term — the Edit row action on the admin Marketing → Search & SEO → Search Terms screen.

TIP

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

Operation

OperationTypePurpose
updateAdminMarketingSearchTermMutationUpdate a search term

Details

  • Requires an admin Bearer token and the marketing.search_seo.search_terms.edit permission.
  • Pass the term's IRI as id. The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values.
  • Only term and redirectUrl are editable. results and uses are recorded automatically by storefront search and cannot be changed.
  • The mutation returns the full updated search-term payload.

Input fields

FieldTypeRequiredNotes
idIDYesThe term's IRI
termStringYesThe search phrase
redirectUrlStringNoA valid URL to redirect this search to, or null to clear

Released under the MIT License.