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 is and how its fields behave.

Endpoint

Endpoint	Method
/api/admin/marketing/search-synonyms/{id}	PUT

Details

• Requires an admin Bearer token and the marketing.search_seo.search_synonyms.edit permission.
• The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values.
• Returns the full updated synonym payload.

Request body

Field	Type	Required	Notes
name	string	no	Group name
terms	string	no	Comma-separated list of interchangeable search words