Skip to content

Update Sitemap

Updates an existing sitemap — the Edit Sitemap action on the admin Marketing → Search & SEO → Sitemaps screen.

TIP

New here? Read the Sitemaps overview for what a sitemap does and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/sitemaps/{id}PUT

Details

  • Requires an admin Bearer token and the marketing.search_seo.sitemaps.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 sitemap payload.

No auto-regeneration

Changing file_name / path does not rebuild the XML. Call generate (POST /api/admin/marketing/sitemaps/{id}/generate) to refresh the files.

Request body

FieldTypeRequiredNotes
file_namestringnoIndex file name — letters, digits, -, _, .; must end with .xml
pathstringnoWhere the index file is written — must start and end with /, no //

Released under the MIT License.