Makeswift Docs

curl -X POST https://api.makeswift.com/v1/regions \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "site-header",
  "name": "Site Header",
  "elements": {
    "type": "makeswift::components::slot::v1",
    "key": "0b8f2f4e-3c1d-4e7a-9f2b-8a6c5d4e3f21",
    "props": {
      "children": {
        "columns": [
          {
            "deviceId": "desktop",
            "value": {
              "count": 12,
              "spans": [
                [
                  12
                ]
              ]
            }
          }
        ],
        "elements": [
          {
            "key": "7d3e9a1b-5c2f-4b8e-a6d4-2f1e0c9b8a7d",
            "props": {
              "alt": {
                "@@makeswift/type": "text-input::v1",
                "value": "Acme"
              }
            },
            "type": "Logo"
          }
        ]
      }
    }
  }
}'

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

Creates a region in one locale. The element tree’s root component type becomes the region’s type. A region in a site locale requires the region to exist in the default locale first.

Authentication

x-api-keystring

API key authentication with an App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ).

Request

This endpoint expects an object.

siteIdstringRequiredformat: "uuid"

The site ID to create the region in.

idstringRequired>=1 character

The region ID, assigned by the host. Unique within a site and locale.

namestringRequired>=1 character

The region name.

elementsobjectRequired

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

localestringOptional

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

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