Update URL Rewrite
Updates an existing URL rewrite — the Edit action on the admin Marketing → Search & SEO → URL Rewrites screen.
TIP
New here? Read the URL Rewrites overview for what a URL rewrite does and how its fields behave.
Operation
| Operation | Type | Purpose |
|---|---|---|
updateAdminMarketingUrlRewrite | Mutation | Update a URL rewrite |
Details
- Requires an admin Bearer token and the
marketing.search_seo.url_rewrites.editpermission. - Pass the rewrite'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 rewrite payload.
Input fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | ID | Yes | The rewrite's IRI |
entityType | String | No | product, category, or cms_page |
requestPath | String | No | Source path the shopper requests |
targetPath | String | No | Destination path the request redirects to |
redirectType | String | No | 301 permanent / 302 temporary |
locale | String | No | Locale code; must exist in the store's locales |