Delete Search Synonym
Deletes a search synonym group — the Delete row action on the admin Marketing → Search & SEO → Search Synonyms screen.
TIP
New here? Read the Search Synonyms overview for what a search synonym does and how its fields behave.
Operation
| Operation | Type | Purpose |
|---|---|---|
deleteAdminMarketingSearchSynonym | Mutation | Delete a search synonym group |
Details
- Requires an admin Bearer token and the
marketing.search_seo.search_synonyms.deletepermission. - Pass the synonym's IRI as
id. Use the list query to discover valid ids.
Confirm success via the absence of errors
The delete mutation returns a success acknowledgement, not the deleted group's data — adminMarketingSearchSynonym resolves to null on the payload. Treat a response with no errors[] as a successful delete. If you need a confirmation message in the body, use the REST endpoint (DELETE /api/admin/marketing/search-synonyms/{id}), which returns { "message": "Search synonym deleted." }.
Input fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | ID | Yes | The synonym's IRI |