Skip to navigation
RESTRegions

Update Region

This feature is in beta and may change. Requests return 403 until the feature flag is enabled for your site or workspace.

Replaces a region’s element tree in one locale. The element tree’s root component type becomes the region’s type. Updating the default locale also updates the localized regions that inherit from it. Pass version to update the region only if it has not changed since you read it.

Authentication

x-api-keystring

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Path parameters

idstringRequired

The region ID. URL-encode it if it contains reserved characters such as /.

Query parameters

siteIdstringRequiredformat: "uuid"
The site ID the region belongs to.
localestringOptional

The locale to update the region in. Accepts either a locale code (e.g. en-US) or a site_locale UUID. Defaults to the site’s default locale.

Request

This endpoint expects an object.
elementsobjectRequired

The root of the region’s element tree. Replaces the tree in full. Its component type becomes the region’s type.

versionintegerOptional>=0

The region version the update is based on, as returned by an earlier request. If the region has changed since, the update fails with 409 and changes nothing. Omit it to update the region regardless.

Response

objectenum
Allowed values:
idstring
The region ID. Assigned by the host, not generated by Makeswift.
namestring
The region name.
typestring
The component type at the root of the region's element tree.
localestring
The locale of this region.
updatedAtdatetime
The region last update date and time.
versioninteger>=0
The version of the region's element tree. It increases with every change to the tree. Pass it to Update Region to update the region only if it has not changed since.
elementsany

Always null here. Get Region returns the region’s element tree with include=elements.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error