Flex Design Template

Description

flex-design-template
Flex Design Template

A ShootProof-provided Flex design ("seed") that studios pick from and customize. Only active templates are returned.

Properties

Property Description
aspectRatio nullable
string

The canvas aspect ratio, e.g. 2 / 1.
body
object

The serialized Flex section (schema version 1). ((tokens)) are left intact for substitution at render time. A template without a body yet gets an empty section: {"columns": 12, "rows": 12, "items": []}.
categories
string[]

Slugs of the picker categories (tabs) this template appears in, sorted. The frontend owns each category's name and the tab order.
created
string
date-time

When this template was created.
description nullable
string

Optional helper copy for the template card.
emailTemplateType nullable
string

The email template type this design is written for, or null for a general design.
id
string

The public identifier (a UUID) of this template. Stable across environments.
lastUpdated
string
date-time

When this template was last updated.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name nullable
string

The display name of this template.
schemaVersion
integer

The Flex section shape version.
scope
string
enum
  • email-header

The Flex catalog this template belongs to.
source
string
enum
  • seed

Where the design comes from, for pickers that mix templates and saved designs.
status
string
enum
  • active

Always active; inactive templates are left out of the catalog.
type
string
enum
  • flex-design-template

The type of object represented.

OpenAPI Schema

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

{
  "description": "A ShootProof-provided Flex design (\"seed\") that studios pick from and customize.\nOnly active templates are returned.",
  "properties": {
    "aspectRatio": {
      "description": "The canvas aspect ratio, e.g. `2 / 1`.",
      "nullable": true,
      "type": "string"
    },
    "body": {
      "description": "The serialized Flex section (schema version 1). `((tokens))` are left intact for substitution at render time.\nA template without a body yet gets an empty section: `{\"columns\": 12, \"rows\": 12, \"items\": []}`.",
      "type": "object"
    },
    "categories": {
      "description": "Slugs of the picker categories (tabs) this template appears in, sorted. The\nfrontend owns each category's name and the tab order.",
      "items": {
        "example": "gallery",
        "type": "string"
      },
      "type": "array"
    },
    "created": {
      "description": "When this template was created.",
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "description": "Optional helper copy for the template card.",
      "nullable": true,
      "type": "string"
    },
    "emailTemplateType": {
      "description": "The email template type this design is written for, or null for a general design.",
      "example": "event-expiring-notice",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "The public identifier (a UUID) of this template. Stable across environments.",
      "type": "string"
    },
    "lastUpdated": {
      "description": "When this template was last updated.",
      "format": "date-time",
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The display name of this template.",
      "nullable": true,
      "type": "string"
    },
    "schemaVersion": {
      "description": "The Flex section shape version.",
      "type": "integer"
    },
    "scope": {
      "description": "The Flex catalog this template belongs to.",
      "enum": [
        "email-header"
      ],
      "type": "string"
    },
    "source": {
      "description": "Where the design comes from, for pickers that mix templates and saved designs.",
      "enum": [
        "seed"
      ],
      "type": "string"
    },
    "status": {
      "description": "Always `active`; inactive templates are left out of the catalog.",
      "enum": [
        "active"
      ],
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "flex-design-template"
      ],
      "type": "string"
    }
  },
  "title": "Flex Design Template",
  "type": "object"
}
Flex Design Template