changedOutput schema / properties / data / items / anyOf
Previous value: -[
- {
- "properties": {
- "color_scheme": {
- "enum": [
- "light",
- "dark",
- null
- ],
- "type": [
- "string",
- "null"
- ]
- },
- "created_at": {
- "format": "date-time",
- "type": "string"
- },
- "css": {
- "type": [
- "string",
- "null"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ]
- },
- "device_scale": {
- "type": [
- "number",
- "null"
- ]
- },
- "disable_twemoji": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "google_fonts": {
- "type": [
- "string",
- "null"
- ]
- },
- "html": {
- "type": [
- "string",
- "null"
- ]
- },
- "id": {
- "type": "string"
- },
- "jumbo_max_height": {
- "type": [
- "integer",
- "null"
- ]
- },
- "jumbo_max_width": {
- "type": [
- "integer",
- "null"
- ]
- },
- "max_wait_ms": {
- "type": [
- "integer",
- "null"
- ]
- },
- "media_type": {
- "enum": [
- "print",
- "screen",
- null
- ],
- "type": [
- "string",
- "null"
- ]
- },
- "ms_delay": {
- "type": [
- "integer",
- "null"
- ]
- },
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "proxy_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "render_count": {
- "type": "integer"
- },
- "render_when_ready": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "storage_destination_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "template_type": {
- "const": "html_css"
- },
- "timezone": {
- "type": [
- "string",
- "null"
- ]
- },
- "transparent_background": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "updated_at": {
- "format": "date-time",
- "type": "string"
- },
- "version": {
- "type": "integer"
- },
- "viewport_height": {
- "type": [
- "integer",
- "null"
- ]
- },
- "viewport_landscape": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_mobile": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_touch": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_width": {
- "type": [
- "integer",
- "null"
- ]
- }
- }
- },
- {
- "properties": {
- "block_counts": {
- "additionalProperties": {
- "type": "integer"
- },
- "type": "object"
- },
- "color_scheme": {
- "enum": [
- "light",
- "dark",
- null
- ],
- "type": [
- "string",
- "null"
- ]
- },
- "created_at": {
- "format": "date-time",
- "type": "string"
- },
- "description": {
- "type": [
- "string",
- "null"
- ]
- },
- "device_scale": {
- "type": [
- "number",
- "null"
- ]
- },
- "disable_twemoji": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "id": {
- "type": "string"
- },
- "jumbo_max_height": {
- "type": [
- "integer",
- "null"
- ]
- },
- "jumbo_max_width": {
- "type": [
- "integer",
- "null"
- ]
- },
- "max_wait_ms": {
- "type": [
- "integer",
- "null"
- ]
- },
- "media_type": {
- "enum": [
- "print",
- "screen",
- null
- ],
- "type": [
- "string",
- "null"
- ]
- },
- "ms_delay": {
- "type": [
- "integer",
- "null"
- ]
- },
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "proxy_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "render_count": {
- "type": "integer"
- },
- "render_when_ready": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "storage_destination_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "template_type": {
- "const": "blocks"
- },
- "timezone": {
- "type": [
- "string",
- "null"
- ]
- },
- "transparent_background": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "updated_at": {
- "format": "date-time",
- "type": "string"
- },
- "variables": {
- "items": {
- "properties": {
- "fallback_value": {
- "description": "The fallback value to use if the template variable is not set and mode is set to 'fallback'."
- },
- "helper_kind": {
- "description": "If this variable is found in a handlebars helper, it will be used to determine the validity of the value provided when creating an image.",
- "enum": [
- "UNKNOWN",
- "None",
- "If",
- "Unless",
- "With",
- "Each"
- ],
- "type": "string"
- },
- "key": {
- "description": "The template key used to assign this variable's value.",
- "type": "string"
- },
- "kind_hint": {
- "description": "The inferred kind of the template variable.",
- "enum": [
- "UNKNOWN",
- "String",
- "Boolean",
- "Integer",
- "Float",
- "Color",
- "Size",
- "Object",
- "Collection"
- ],
- "type": "string"
- },
- "mode": {
- "description": "Whether the template variable is required, ignored, or has a fallback value.",
- "enum": [
- "Required",
- "Ignore",
- "Fallback"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "version": {
- "type": "integer"
- },
- "viewport_height": {
- "type": [
- "integer",
- "null"
- ]
- },
- "viewport_landscape": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_mobile": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_touch": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "viewport_width": {
- "type": [
- "integer",
- "null"
- ]
- }
- }
- }
-]New value: +[
+ {
+ "description": "A template with template_type: html_css. Contains the saved HTML, CSS, and rendering settings. Supply template_values when rendering to substitute placeholder values; update the template to change the saved design.",
+ "properties": {
+ "color_scheme": {
+ "description": "Stored light or dark color-scheme preference exposed to the rendered page's CSS.",
+ "enum": [
+ "light",
+ "dark",
+ null
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "created_at": {
+ "description": "UTC timestamp when this template version was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "css": {
+ "description": "Saved CSS used to style the template. Handlebars substitutions are evaluated in html, so place dynamic style values there.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": {
+ "description": "Optional notes about the template's purpose and intended use.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "device_scale": {
+ "description": "Stored screenshot pixel ratio. For example, 2 produces two output pixels per CSS pixel in each dimension. Null uses the rendering default.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "disable_twemoji": {
+ "description": "Whether native emoji rendering is used instead of Twemoji. Null leaves the rendering default in effect.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "google_fonts": {
+ "description": "Google Font families loaded for this template, separated by |. The HTML or CSS must reference the families to use them.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "html": {
+ "description": "Saved HTML source, including any Handlebars placeholders such as {{title}}. Pass matching values without braces, such as a title property in template_values, when rendering.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "Unique template identifier used when rendering or updating this template.",
+ "type": "string"
+ },
+ "jumbo_max_height": {
+ "description": "Stored maximum output height in pixels for jumbo rendering. Used with jumbo_max_width; jumbo rendering consumes additional image credits.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "jumbo_max_width": {
+ "description": "Stored maximum output width in pixels for jumbo rendering. Used with jumbo_max_height.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "max_wait_ms": {
+ "description": "Stored loading-wait limit in milliseconds before capture.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "media_type": {
+ "description": "Stored CSS media mode: print or screen.",
+ "enum": [
+ "print",
+ "screen",
+ null
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "ms_delay": {
+ "description": "Stored additional delay in milliseconds before capture, used to allow client-side content to finish updating.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "Optional display name for template discovery. Use id to identify the template in rendering and update requests.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "proxy_id": {
+ "description": "Identifier of the configured organization proxy used for rendering. Proxy connection details are available through the proxy configuration.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "render_count": {
+ "description": "Number of image creations recorded for this template version. Organization-wide image-credit usage is reported separately.",
+ "type": "integer"
+ },
+ "render_when_ready": {
+ "description": "Whether capture waits for the template's JavaScript to call ScreenshotReady(). When enabled, rendering fails if the readiness signal is never sent.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "selector": {
+ "description": "CSS selector used to crop rendered images to an element. Preserve this setting when updating the template unless the intended crop changes.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "storage_destination_id": {
+ "description": "Identifier of the configured destination for rendered files. The destination configuration specifies its provider, enabled state, and storage behavior.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "template_type": {
+ "const": "html_css"
+ },
+ "timezone": {
+ "description": "Stored IANA timezone identifier exposed to the rendered page, such as America/New_York or UTC.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "transparent_background": {
+ "description": "Whether the browser's default background is transparent. Backgrounds explicitly painted by the template's HTML or CSS still apply.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "updated_at": {
+ "description": "UTC timestamp when this template version was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "version": {
+ "description": "Saved template version identifier. Specify it when rendering to select this exact version.",
+ "type": "integer"
+ },
+ "viewport_height": {
+ "description": "Stored browser viewport height in CSS pixels. Used with viewport_width; setting both disables automatic cropping.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "viewport_landscape": {
+ "description": "Whether the emulated viewport uses landscape orientation.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_mobile": {
+ "description": "Whether mobile viewport emulation is enabled, including support for the page's meta viewport tag.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_touch": {
+ "description": "Whether touch support is exposed to the rendered page.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_width": {
+ "description": "Stored browser viewport width in CSS pixels. Used with viewport_height; output pixel dimensions also depend on device_scale.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ }
+ }
+ },
+ {
+ "description": "A template with template_type: blocks, authored in the visual template editor. Contains block counts and variable requirements for rendering. Edit the block design in the template editor.",
+ "properties": {
+ "block_counts": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "description": "Number of blocks of each type in the saved design, keyed by block type name. This summarizes the design rather than exposing its editable block tree.",
+ "type": "object"
+ },
+ "color_scheme": {
+ "description": "Stored light or dark color-scheme preference exposed to the rendered page's CSS.",
+ "enum": [
+ "light",
+ "dark",
+ null
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "created_at": {
+ "description": "UTC timestamp when this template version was created.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional notes about the template's purpose and intended use.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "device_scale": {
+ "description": "Stored screenshot pixel ratio. For example, 2 produces two output pixels per CSS pixel in each dimension. Null uses the rendering default.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "disable_twemoji": {
+ "description": "Whether native emoji rendering is used instead of Twemoji. Null leaves the rendering default in effect.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "Unique template identifier used when rendering or updating this template.",
+ "type": "string"
+ },
+ "jumbo_max_height": {
+ "description": "Stored maximum output height in pixels for jumbo rendering. Used with jumbo_max_width; jumbo rendering consumes additional image credits.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "jumbo_max_width": {
+ "description": "Stored maximum output width in pixels for jumbo rendering. Used with jumbo_max_height.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "max_wait_ms": {
+ "description": "Stored loading-wait limit in milliseconds before capture.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "media_type": {
+ "description": "Stored CSS media mode: print or screen.",
+ "enum": [
+ "print",
+ "screen",
+ null
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "ms_delay": {
+ "description": "Stored additional delay in milliseconds before capture, used to allow client-side content to finish updating.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "Optional display name for template discovery. Use id to identify the template in rendering and update requests.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "proxy_id": {
+ "description": "Identifier of the configured organization proxy used for rendering. Proxy connection details are available through the proxy configuration.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "render_count": {
+ "description": "Number of image creations recorded for this template version. Organization-wide image-credit usage is reported separately.",
+ "type": "integer"
+ },
+ "render_when_ready": {
+ "description": "Whether capture waits for the template's JavaScript to call ScreenshotReady(). When enabled, rendering fails if the readiness signal is never sent.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "selector": {
+ "description": "CSS selector used to crop rendered images to an element. Preserve this setting when updating the template unless the intended crop changes.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "storage_destination_id": {
+ "description": "Identifier of the configured destination for rendered files. The destination configuration specifies its provider, enabled state, and storage behavior.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "template_type": {
+ "const": "blocks"
+ },
+ "timezone": {
+ "description": "Stored IANA timezone identifier exposed to the rendered page, such as America/New_York or UTC.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "transparent_background": {
+ "description": "Whether the browser's default background is transparent. Backgrounds explicitly painted by the template's HTML or CSS still apply.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "updated_at": {
+ "description": "UTC timestamp when this template version was last updated.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "variables": {
+ "description": "Discovered template variables and their value requirements. Use these entries to prepare template_values for a rendering request.",
+ "items": {
+ "description": "A variable discovered in a block template, with its key, requirement mode, inferred value kind, and any fallback or helper context.",
+ "properties": {
+ "fallback_value": {
+ "description": "Saved fallback JSON value used when the variable is missing and its mode selects fallback behavior. Preserve its JSON value type when supplying an override."
+ },
+ "helper_kind": {
+ "description": "Handlebars helper context used during value validation, such as if, unless, with, or each. Interpret this together with mode and kind_hint when preparing template_values.",
+ "enum": [
+ "UNKNOWN",
+ "None",
+ "If",
+ "Unless",
+ "With",
+ "Each"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "Variable name or path used in template_values, without Handlebars braces. Preserve its casing and nesting when supplying values.",
+ "type": "string"
+ },
+ "kind_hint": {
+ "description": "Inferred value kind, such as string, boolean, integer, color, object, or collection. Use it to choose an appropriate JSON value; an unknown kind provides no type guidance.",
+ "enum": [
+ "UNKNOWN",
+ "String",
+ "Boolean",
+ "Integer",
+ "Float",
+ "Color",
+ "Size",
+ "Object",
+ "Collection"
+ ],
+ "type": "string"
+ },
+ "mode": {
+ "description": "Whether the template variable is required, ignored, or has a fallback value.",
+ "enum": [
+ "Required",
+ "Ignore",
+ "Fallback"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "version": {
+ "description": "Saved template version identifier. Specify it when rendering to select this exact version.",
+ "type": "integer"
+ },
+ "viewport_height": {
+ "description": "Stored browser viewport height in CSS pixels. Used with viewport_width; setting both disables automatic cropping.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "viewport_landscape": {
+ "description": "Whether the emulated viewport uses landscape orientation.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_mobile": {
+ "description": "Whether mobile viewport emulation is enabled, including support for the page's meta viewport tag.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_touch": {
+ "description": "Whether touch support is exposed to the rendered page.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "viewport_width": {
+ "description": "Stored browser viewport width in CSS pixels. Used with viewport_height; output pixel dimensions also depend on device_scale.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ }
+ }
+ }
+]
