Flex Design In Patch

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "Partial saved Flex design update. Only provide properties that need updating; `scope` and `templateId` can't change.",
  "properties": {
    "aspectRatio": {
      "description": "The canvas aspect ratio, e.g. `2 / 1`.",
      "maxLength": 16,
      "type": "string"
    },
    "body": {
      "description": "The serialized Flex section (a JSON object, at most 64 KB).",
      "type": "object"
    },
    "id": {
      "description": "The public identifier of this design. If sent, must match the resource URI.",
      "type": "string"
    },
    "name": {
      "description": "The name shown in My Designs.",
      "maxLength": 250,
      "type": "string"
    },
    "schemaVersion": {
      "description": "The Flex section shape version.",
      "minimum": 1,
      "type": "integer"
    },
    "status": {
      "description": "Set to `inactive` to deactivate the design without deleting it.",
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "flex-design"
      ],
      "type": "string"
    }
  },
  "title": "Flex Design In Patch",
  "type": "object"
}