Makeswift Docs

curl -X POST https://api.makeswift.com/v1/regions/$bulk \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "regions": [
    {
      "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"
              }
            ]
          }
        }
      }
    }
  ]
}'

[
  {
    "data": {
      "elements": null,
      "id": "site-header",
      "locale": "en-US",
      "name": "Site Header",
      "object": "region",
      "type": "makeswift::components::slot::v1",
      "updatedAt": {},
      "version": 3
    },
    "success": true
  }
]

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

Creates up to 1000 regions, each like Create Region. The response has one result per region, in request order: the created region, or the error that kept it from being created. An error in one region does not keep the others from being created. Only an error in the request itself, such as an invalid body, rejects the whole batch.

Regions in the default locale are created before regions in site locales, so a region in a site locale may come before its default locale’s region in the batch.

The request body is limited to 500 KB, and a larger one is rejected with 413, so a request with element trees may hold fewer regions than that.

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 regions in.

regionslist of objectsRequired

The regions to create.

Response

object

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error