Update Search Synonym
Updates an existing search synonym group — the Edit Synonym 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 |
|---|---|---|
updateAdminMarketingSearchSynonym | Mutation | Update a search synonym group |
Details
- Requires an admin Bearer token and the
marketing.search_seo.search_synonyms.editpermission. - Pass the synonym's IRI as
id. The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values. - The mutation returns the full updated synonym payload.
Input fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | ID | Yes | The synonym's IRI |
name | String | No | Group name |
terms | String | No | Comma-separated list of interchangeable search words |