Skip to content

Mass Delete Search Synonyms

Deletes several search synonym groups in one call — the Mass Delete action on the admin Marketing → Search & SEO → Search Synonyms datagrid.

TIP

New here? Read the Search Synonyms overview for what a search synonym does and how its fields behave.

Operation

OperationTypePurpose
createAdminMarketingSearchSynonymMassDeleteMutationDelete multiple search synonym groups

Details

  • Requires an admin Bearer token and the marketing.search_seo.search_synonyms.delete permission.
  • Pass the numeric synonym ids in indices. Non-existent ids are silently skipped (returned in skipped); the ids actually removed are returned in deleted.
  • An empty or missing indices list returns a 422 error.

Input fields

FieldTypeRequiredNotes
indicesArrayYesNon-empty list of numeric synonym ids to delete

Released under the MIT License.