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.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/url-rewrites/{id} | PUT |
Details
- Requires an admin Bearer token and the
marketing.search_seo.url_rewrites.editpermission. - The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values.
- Returns the full updated rewrite payload.
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
entity_type | string | no | product, category, or cms_page |
request_path | string | no | Source path the shopper requests |
target_path | string | no | Path the shopper is redirected to |
redirect_type | string | no | 301 permanent / 302 temporary |
locale | string | no | Locale code; must exist in the store's locales |