Makeswift Docs

curl -X PATCH 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",
      "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.

Updates up to 1000 regions, each like Update Region. The response has one result per region, in request order: the updated region, or the error that kept it from being updated. An error in one region does not keep the others from being updated. Only an error in the request itself, such as an invalid body, rejects the whole 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. Accepts either:

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

Request

This endpoint expects an object.

siteIdstringRequiredformat: "uuid"

The site ID to update the regions in.

regionslist of objectsRequired

The regions to update.

Response

object

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error