addedInput schema / $defs
Added value: +{
+ "ConditionSetOperator": {
+ "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
+ "enum": [
+ "and",
+ "or"
+ ],
+ "title": "ConditionSetOperator",
+ "type": "string"
+ },
+ "ContentMergeStrategy": {
+ "description": "Controls how provided `blocks` interact with the post's existing content. Defaults to `replace`. Use `append_to_template` to preserve template header blocks when updating posts that were created from a template.",
+ "enum": [
+ "replace",
+ "append_to_template",
+ "append",
+ "prepend"
+ ],
+ "title": "ContentMergeStrategy",
+ "type": "string"
+ },
+ "ParagraphBlockTextSection": {
+ "additionalProperties": false,
+ "properties": {
+ "highlight_color": {
+ "description": "The CSS color value for the text highlight.",
+ "type": "string"
+ },
+ "link": {
+ "additionalProperties": false,
+ "description": "The link of the text.",
+ "properties": {
+ "href": {
+ "description": "The URL of the link.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The target of the link (e.g., _blank).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ],
+ "title": "Link",
+ "type": "object"
+ },
+ "styling": {
+ "description": "The inline styles for the text.",
+ "items": {
+ "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
+ "enum": [
+ "bold",
+ "italic",
+ "underline",
+ "strikethrough"
+ ],
+ "title": "ParagraphBlockTextStyle",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "text": {
+ "description": "The text content of the paragraph.",
+ "type": "string"
+ },
+ "text_color": {
+ "description": "The CSS color value for the text.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "text"
+ ],
+ "title": "ParagraphBlockTextSection",
+ "type": "object"
+ },
+ "PostEmailSettings": {
+ "additionalProperties": false,
+ "description": "The email settings to use for this post. Only the provided fields within this object will be updated.",
+ "properties": {
+ "custom_live_url": {
+ "type": "string"
+ },
+ "display_byline_in_email": {
+ "type": "boolean"
+ },
+ "display_subtitle_in_email": {
+ "type": "boolean"
+ },
+ "display_title_in_email": {
+ "type": "boolean"
+ },
+ "email_header_engagement_buttons": {
+ "type": "string"
+ },
+ "email_header_social_share": {
+ "type": "string"
+ },
+ "email_preview_text": {
+ "type": "string"
+ },
+ "email_subject_line": {
+ "type": "string"
+ },
+ "from_address": {
+ "type": "string"
+ },
+ "reply_to_address": {
+ "description": "Email address to set as Reply-To. Must be a verified reply-to address owned by the publication. Returns 422 if not found.",
+ "type": "string"
+ },
+ "sender_name": {
+ "description": "The sender name preset, expressed as a composition key: either a single token, or ` | | `. Tokens are `brand`, `list`, `authors_first` and `authors_full`; connectors are `from`, `with`, `by`, `at`, `comma`, `colon` and `space`. For a post by Jane Doe on the publication Bee Informed, `authors_first|from|brand` renders as \"Jane from Bee Informed\". The `list` token only resolves when the post is associated with a newsletter list. Pass `null` to clear the override and inherit from the newsletter list or publication.",
+ "pattern": "^(brand|list|authors_first|authors_full)(\\|(from|with|by|at|comma|colon|space)\\|(brand|list|authors_first|authors_full))?$",
+ "type": "string"
+ }
+ },
+ "title": "PostEmailSettings",
+ "type": "object"
+ },
+ "PostMetadata": {
+ "additionalProperties": false,
+ "description": "The SEO metadata to use for this post. Only the provided fields within this object will be updated.",
+ "properties": {
+ "default_description": {
+ "type": "string"
+ },
+ "default_title": {
+ "type": "string"
+ },
+ "og_description": {
+ "type": "string"
+ },
+ "og_title": {
+ "type": "string"
+ },
+ "twitter_description": {
+ "type": "string"
+ },
+ "twitter_title": {
+ "type": "string"
+ }
+ },
+ "title": "PostMetadata",
+ "type": "object"
+ },
+ "PostPublishStatus": {
+ "default": "draft",
+ "description": "Transition the post's status. Use `confirmed` to schedule or publish a draft post. Only the `draft` → `confirmed` transition is supported : a confirmed post cannot be moved back to `draft`.",
+ "enum": [
+ "draft",
+ "confirmed"
+ ],
+ "title": "PostPublishStatus",
+ "type": "string"
+ },
+ "PostRecipients": {
+ "additionalProperties": false,
+ "description": "The recipients for this post. When provided, replaces all existing web and email audience targets with the specified values. If omitted, existing targets are unchanged.",
+ "properties": {
+ "email": {
+ "additionalProperties": false,
+ "description": "Email audience targeting. Omit this key to create no email targets.",
+ "properties": {
+ "exclude_segment_ids": {
+ "items": {
+ "description": "The prefixed ID of the segment.",
+ "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
+ "title": "SegmentId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "include_segment_ids": {
+ "description": "Cannot be combined with `tier_ids`.",
+ "items": {
+ "description": "The prefixed ID of the segment.",
+ "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
+ "title": "SegmentId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tier_ids": {
+ "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier. Cannot be combined with `include_segment_ids`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "title": "PostEmailRecipients",
+ "type": "object"
+ },
+ "web": {
+ "additionalProperties": false,
+ "description": "Web audience targeting. Omit this key to create no web targets.",
+ "properties": {
+ "exclude_segment_ids": {
+ "items": {
+ "description": "The prefixed ID of the segment.",
+ "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
+ "title": "SegmentId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "include_segment_ids": {
+ "items": {
+ "description": "The prefixed ID of the segment.",
+ "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
+ "title": "SegmentId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tier_ids": {
+ "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "title": "PostWebRecipients",
+ "type": "object"
+ }
+ },
+ "required": [
+ "web",
+ "email"
+ ],
+ "title": "PostRecipients",
+ "type": "object"
+ },
+ "PostWebSettings": {
+ "additionalProperties": false,
+ "description": "The web settings to use for this post. Only the provided fields within this object will be updated.",
+ "properties": {
+ "display_subtitle_on_web": {
+ "type": "boolean"
+ },
+ "display_thumbnail_on_web": {
+ "type": "boolean"
+ },
+ "display_title_on_web": {
+ "type": "boolean"
+ },
+ "hide_from_feed": {
+ "type": "boolean"
+ },
+ "paywall_break_price_id": {
+ "description": "The prefixed ID of the price.",
+ "pattern": "^(price_[0-9a-fA-F\\-]+)$",
+ "title": "PriceId",
+ "type": "string"
+ },
+ "paywall_id": {
+ "description": "The prefixed ID of the paywall.",
+ "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
+ "title": "PaywallId",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ }
+ },
+ "title": "PostWebSettings",
+ "type": "object"
+ },
+ "VisibilitySettings": {
+ "additionalProperties": false,
+ "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
+ "properties": {
+ "condition_set_ids": {
+ "$ref": "#/$defs/condition_set_ids"
+ },
+ "condition_set_operator": {
+ "$ref": "#/$defs/ConditionSetOperator"
+ },
+ "show_on_email": {
+ "description": "Whether to show the block on the email.",
+ "type": "boolean"
+ },
+ "show_on_web": {
+ "description": "Whether to show the block on the web.",
+ "type": "boolean"
+ },
+ "show_to_anonymous_users_web": {
+ "description": "Whether to show the block to anonymous users on the web.",
+ "type": "boolean"
+ },
+ "show_to_free_subscribers": {
+ "description": "Whether to show the block to free subscribers.",
+ "type": "boolean"
+ },
+ "show_to_paid_subscribers": {
+ "description": "Whether to show the block to paid subscribers.",
+ "type": "boolean"
+ },
+ "show_to_subscribers_with_referral_condition": {
+ "description": "The condition required to show the block to subscribers.",
+ "enum": [
+ "eq",
+ "gt",
+ "lt"
+ ],
+ "title": "ReferralCondition",
+ "type": "string"
+ },
+ "show_to_subscribers_with_referral_value": {
+ "description": "The exact referral count required to show the block to subscribers.",
+ "type": "integer"
+ }
+ },
+ "title": "VisibilitySettings",
+ "type": "object"
+ },
+ "VisualSettings": {
+ "additionalProperties": false,
+ "description": "Optional styling for borders, spacing, colors, etc.",
+ "properties": {
+ "background_color": {
+ "description": "The background color of the block.",
+ "type": "string"
+ },
+ "border_color": {
+ "description": "The border color of the block.",
+ "type": "string"
+ },
+ "border_radius": {
+ "description": "The border radius of the block.",
+ "type": "integer"
+ },
+ "border_radius_bottom_left": {
+ "description": "The border radius of the bottom left of the block.",
+ "type": "integer"
+ },
+ "border_radius_bottom_right": {
+ "description": "The border radius of the bottom right of the block.",
+ "type": "integer"
+ },
+ "border_radius_top_left": {
+ "description": "The border radius of the top left of the block.",
+ "type": "integer"
+ },
+ "border_radius_top_right": {
+ "description": "The border radius of the top right of the block.",
+ "type": "integer"
+ },
+ "border_style": {
+ "description": "The border style of the block.",
+ "enum": [
+ "solid",
+ "dashed",
+ "dotted"
+ ],
+ "title": "BorderStyle",
+ "type": "string"
+ },
+ "border_width": {
+ "description": "The border width of the block.",
+ "type": "integer"
+ },
+ "border_width_bottom": {
+ "description": "The border width of the bottom of the block.",
+ "type": "integer"
+ },
+ "border_width_left": {
+ "description": "The border width of the left of the block.",
+ "type": "integer"
+ },
+ "border_width_right": {
+ "description": "The border width of the right of the block.",
+ "type": "integer"
+ },
+ "border_width_top": {
+ "description": "The border width of the top of the block.",
+ "type": "integer"
+ },
+ "inner_spacing": {
+ "description": "The inner spacing of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_bottom": {
+ "description": "The inner spacing of the bottom of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_left": {
+ "description": "The inner spacing of the left of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_right": {
+ "description": "The inner spacing of the right of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_top": {
+ "description": "The inner spacing of the top of the block.",
+ "type": "integer"
+ },
+ "outer_spacing": {
+ "description": "The outer spacing of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_bottom": {
+ "description": "The outer spacing of the bottom of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_left": {
+ "description": "The outer spacing of the left of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_right": {
+ "description": "The outer spacing of the right of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_top": {
+ "description": "The outer spacing of the top of the block.",
+ "type": "integer"
+ },
+ "text_color": {
+ "description": "The text color of the block.",
+ "type": "string"
+ }
+ },
+ "title": "VisualSettings",
+ "type": "object"
+ },
+ "advertisement": {
+ "additionalProperties": false,
+ "properties": {
+ "opportunity_id": {
+ "description": "The ID of the Advertisement opportunity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: advertisement",
+ "enum": [
+ "advertisement"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "opportunity_id"
+ ],
+ "type": "object"
+ },
+ "blocks": {
+ "description": "The structured content blocks for the post. How these interact with existing content depends on `content_merge_strategy` (default: full replacement). Supports block types such as paragraph, image, heading, button, html, table, list, columns, and more. Cannot be provided together with `body_content`.",
+ "items": {
+ "description": "A block in the post content.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/paragraph"
+ },
+ {
+ "$ref": "#/$defs/image"
+ },
+ {
+ "$ref": "#/$defs/button"
+ },
+ {
+ "$ref": "#/$defs/heading"
+ },
+ {
+ "$ref": "#/$defs/rss"
+ },
+ {
+ "$ref": "#/$defs/advertisement"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "advertisement_kind": {
+ "description": "The automated advertisement kind to fill at publish time.",
+ "enum": [
+ "primary",
+ "secondary"
+ ],
+ "title": "AutomatedAdvertisementKind",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: automated_advertisement_placement",
+ "enum": [
+ "automated_advertisement_placement"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "advertisement_kind"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "override_align": {
+ "description": "The logo alignment. Defaults to center.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "override_sponsor_text": {
+ "description": "The sponsor text to display with the advertisement logo. Required.",
+ "enum": [
+ "sponsored_by",
+ "together_with",
+ "in_partnership_with",
+ "presented_by",
+ "todays_sponsor"
+ ],
+ "title": "ProgrammaticAdsSponsorText",
+ "type": "string"
+ },
+ "override_width": {
+ "description": "The logo width as a percentage. Must be greater than 0. Defaults to 100.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "Discriminator value: programmatic_ads_logo",
+ "enum": [
+ "programmatic_ads_logo"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "override_sponsor_text"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "columns": {
+ "description": "The blocks that make up the columns.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "blocks": {
+ "description": "The blocks that make up the column.",
+ "items": {
+ "description": "A block in the post content that can be embedded within a column.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/paragraph"
+ },
+ {
+ "$ref": "#/$defs/image"
+ },
+ {
+ "$ref": "#/$defs/button"
+ },
+ {
+ "$ref": "#/$defs/heading"
+ },
+ {
+ "$ref": "#/$defs/rss"
+ },
+ {
+ "$ref": "#/$defs/advertisement"
+ }
+ ],
+ "title": "EmbeddableBlocks"
+ },
+ "type": "array"
+ },
+ "position": {
+ "description": "The column position. This field is deprecated but supported for existing column layouts.",
+ "enum": [
+ "left",
+ "right"
+ ],
+ "title": "ColumnPosition",
+ "type": "string"
+ },
+ "verticalAlign": {
+ "description": "The vertical alignment of the column content.",
+ "enum": [
+ "top",
+ "middle",
+ "bottom"
+ ],
+ "title": "ColumnVerticalAlignment",
+ "type": "string"
+ },
+ "width": {
+ "description": "The column width percentage. When omitted, width is calculated automatically.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "blocks"
+ ],
+ "title": "ColumnBlock",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "stackOnMobile": {
+ "default": true,
+ "description": "Whether columns should stack vertically on mobile devices.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Discriminator value: columns",
+ "enum": [
+ "columns"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "columns"
+ ],
+ "type": "object"
+ },
+ {
+ "$ref": "#/$defs/list"
+ },
+ {
+ "$ref": "#/$defs/table"
+ },
+ {
+ "$ref": "#/$defs/html"
+ },
+ {
+ "$ref": "#/$defs/embed_link"
+ },
+ {
+ "$ref": "#/$defs/poll"
+ },
+ {
+ "$ref": "#/$defs/quote"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "Discriminator value: content_break",
+ "enum": [
+ "content_break"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "$ref": "#/$defs/paywall_break"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "blocks": {
+ "description": "The blocks to group inside this section. Must contain at least one block. Cannot contain `section` or `columns` blocks.",
+ "items": {
+ "description": "A block that can appear inside a section. Excludes `section` and `columns` (TipTap's schema does not allow nested sections).",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/paragraph"
+ },
+ {
+ "$ref": "#/$defs/image"
+ },
+ {
+ "$ref": "#/$defs/button"
+ },
+ {
+ "$ref": "#/$defs/heading"
+ },
+ {
+ "$ref": "#/$defs/rss"
+ },
+ {
+ "$ref": "#/$defs/advertisement"
+ },
+ {
+ "$ref": "#/$defs/list"
+ },
+ {
+ "$ref": "#/$defs/table"
+ },
+ {
+ "$ref": "#/$defs/html"
+ },
+ {
+ "$ref": "#/$defs/embed_link"
+ },
+ {
+ "$ref": "#/$defs/poll"
+ },
+ {
+ "$ref": "#/$defs/quote"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "Discriminator value: content_break",
+ "enum": [
+ "content_break"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "$ref": "#/$defs/paywall_break"
+ }
+ ],
+ "title": "SectionableBlock"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Discriminator value: section",
+ "enum": [
+ "section"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "additionalProperties": false,
+ "description": "Optional rules for when/where this section is shown, including dynamic content targeting via condition sets.",
+ "properties": {
+ "condition_set_ids": {
+ "$ref": "#/$defs/condition_set_ids"
+ },
+ "condition_set_operator": {
+ "$ref": "#/$defs/ConditionSetOperator"
+ },
+ "show_on_email": {
+ "description": "Whether to show the block on the email.",
+ "type": "boolean"
+ },
+ "show_on_web": {
+ "description": "Whether to show the block on the web.",
+ "type": "boolean"
+ },
+ "show_to_anonymous_users_web": {
+ "description": "Whether to show the block to anonymous users on the web.",
+ "type": "boolean"
+ },
+ "show_to_free_subscribers": {
+ "description": "Whether to show the block to free subscribers.",
+ "type": "boolean"
+ },
+ "show_to_paid_subscribers": {
+ "description": "Whether to show the block to paid subscribers.",
+ "type": "boolean"
+ },
+ "show_to_subscribers_with_referral_condition": {
+ "description": "The condition required to show the block to subscribers.",
+ "enum": [
+ "eq",
+ "gt",
+ "lt"
+ ],
+ "title": "ReferralCondition",
+ "type": "string"
+ },
+ "show_to_subscribers_with_referral_value": {
+ "description": "The exact referral count required to show the block to subscribers.",
+ "type": "integer"
+ }
+ },
+ "title": "VisibilitySettings",
+ "type": "object"
+ },
+ "visual_settings": {
+ "additionalProperties": false,
+ "description": "Optional styling applied to the section as a whole (background color, padding, borders, etc.).",
+ "properties": {
+ "background_color": {
+ "description": "The background color of the block.",
+ "type": "string"
+ },
+ "border_color": {
+ "description": "The border color of the block.",
+ "type": "string"
+ },
+ "border_radius": {
+ "description": "The border radius of the block.",
+ "type": "integer"
+ },
+ "border_radius_bottom_left": {
+ "description": "The border radius of the bottom left of the block.",
+ "type": "integer"
+ },
+ "border_radius_bottom_right": {
+ "description": "The border radius of the bottom right of the block.",
+ "type": "integer"
+ },
+ "border_radius_top_left": {
+ "description": "The border radius of the top left of the block.",
+ "type": "integer"
+ },
+ "border_radius_top_right": {
+ "description": "The border radius of the top right of the block.",
+ "type": "integer"
+ },
+ "border_style": {
+ "description": "The border style of the block.",
+ "enum": [
+ "solid",
+ "dashed",
+ "dotted"
+ ],
+ "title": "BorderStyle",
+ "type": "string"
+ },
+ "border_width": {
+ "description": "The border width of the block.",
+ "type": "integer"
+ },
+ "border_width_bottom": {
+ "description": "The border width of the bottom of the block.",
+ "type": "integer"
+ },
+ "border_width_left": {
+ "description": "The border width of the left of the block.",
+ "type": "integer"
+ },
+ "border_width_right": {
+ "description": "The border width of the right of the block.",
+ "type": "integer"
+ },
+ "border_width_top": {
+ "description": "The border width of the top of the block.",
+ "type": "integer"
+ },
+ "inner_spacing": {
+ "description": "The inner spacing of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_bottom": {
+ "description": "The inner spacing of the bottom of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_left": {
+ "description": "The inner spacing of the left of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_right": {
+ "description": "The inner spacing of the right of the block.",
+ "type": "integer"
+ },
+ "inner_spacing_top": {
+ "description": "The inner spacing of the top of the block.",
+ "type": "integer"
+ },
+ "outer_spacing": {
+ "description": "The outer spacing of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_bottom": {
+ "description": "The outer spacing of the bottom of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_left": {
+ "description": "The outer spacing of the left of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_right": {
+ "description": "The outer spacing of the right of the block.",
+ "type": "integer"
+ },
+ "outer_spacing_top": {
+ "description": "The outer spacing of the top of the block.",
+ "type": "integer"
+ },
+ "text_color": {
+ "description": "The text color of the block.",
+ "type": "string"
+ }
+ },
+ "title": "VisualSettings",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type",
+ "blocks"
+ ],
+ "type": "object"
+ }
+ ],
+ "title": "Block"
+ },
+ "type": "array"
+ },
+ "body_content": {
+ "description": "Raw HTML to replace the post's current content. The HTML is wrapped in an `htmlSnippet` block internally. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling. Cannot be provided together with `blocks`.",
+ "type": "string"
+ },
+ "button": {
+ "additionalProperties": false,
+ "properties": {
+ "alignment": {
+ "description": "The text alignment of the button.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "href": {
+ "description": "The URL the button should use.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the button (e.g., small, normal, large).",
+ "enum": [
+ "small",
+ "normal",
+ "large"
+ ],
+ "title": "Sizes",
+ "type": "string"
+ },
+ "target": {
+ "description": "The target of the button (e.g., _blank).",
+ "type": "string"
+ },
+ "text": {
+ "description": "The text content of the button.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: button",
+ "enum": [
+ "button"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "href",
+ "text"
+ ],
+ "type": "object"
+ },
+ "condition_set_ids": {
+ "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "embed_link": {
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "Discriminator value: embed_link",
+ "enum": [
+ "embed_link"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL of the embed link.",
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "url"
+ ],
+ "type": "object"
+ },
+ "guest_author_ids": {
+ "description": "The prefixed IDs of the guest authors to associate with this post. Guest authors must belong to the publication. When provided, replaces all existing guest authors on the post.",
+ "items": {
+ "description": "The prefixed ID of the guest author.",
+ "pattern": "^(guest_[0-9a-fA-F\\-]+)$",
+ "title": "GuestAuthorId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "Custom email headers for this post. Merges with newsletter list and publication headers at send time, with this post's values winning on a key collision. Set a value to `null` to suppress a header inherited from the newsletter list or publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden.",
+ "type": "object"
+ },
+ "heading": {
+ "additionalProperties": false,
+ "properties": {
+ "anchorHeader": {
+ "default": true,
+ "description": "Whether the header should be an anchor header.",
+ "type": "boolean"
+ },
+ "anchorIncludeInToc": {
+ "default": true,
+ "description": "Whether the header should be included in the table of contents.",
+ "type": "boolean"
+ },
+ "formattedText": {
+ "description": "The formatted content of the header, supporting links and inline styling.",
+ "items": {
+ "$ref": "#/$defs/ParagraphBlockTextSection"
+ },
+ "type": "array"
+ },
+ "level": {
+ "description": "The level of the header (e.g., 1, 2, 3, etc.).",
+ "enum": [
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6"
+ ],
+ "title": "HeadingLevel",
+ "type": "string"
+ },
+ "text": {
+ "description": "The text content of the header. Ignored if `formattedText` is provided.",
+ "type": "string"
+ },
+ "textAlignment": {
+ "description": "The text alignment of the header (e.g., left, center, right).",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: heading",
+ "enum": [
+ "heading"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "level"
+ ],
+ "type": "object"
+ },
+ "html": {
+ "additionalProperties": false,
+ "properties": {
+ "html": {
+ "description": "The raw HTML content. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: html",
+ "enum": [
+ "html"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "html"
+ ],
+ "type": "object"
+ },
+ "image": {
+ "additionalProperties": false,
+ "properties": {
+ "alt_text": {
+ "description": "Alternative text for the image.",
+ "type": "string"
+ },
+ "caption": {
+ "description": "A caption for the image.",
+ "type": "string"
+ },
+ "captionAlignment": {
+ "description": "The text alignment of the caption.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "imageAlignment": {
+ "description": "The text alignment of the image.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "imageUrl": {
+ "description": "The URL of the image.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the image.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: image",
+ "enum": [
+ "image"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL that the image should link to.",
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ },
+ "width": {
+ "description": "The width of the image. Should be between 1 and 100.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "type",
+ "imageUrl"
+ ],
+ "type": "object"
+ },
+ "list": {
+ "additionalProperties": false,
+ "properties": {
+ "items": {
+ "description": "The items in the list.",
+ "items": {
+ "description": "A list item as either plain text or formatted text data.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "formattedText": {
+ "description": "The formatted content of the list item.",
+ "items": {
+ "$ref": "#/$defs/ParagraphBlockTextSection"
+ },
+ "type": "array"
+ },
+ "text": {
+ "description": "The plain text content of the list item.",
+ "type": "string"
+ }
+ },
+ "title": "ListBlockItemData",
+ "type": "object"
+ }
+ ],
+ "title": "ListBlockItem"
+ },
+ "type": "array"
+ },
+ "listType": {
+ "description": "The type of list (e.g., ordered, unordered).",
+ "enum": [
+ "ordered",
+ "unordered"
+ ],
+ "title": "ListType",
+ "type": "string"
+ },
+ "startNumber": {
+ "description": "The number to start the list at. Only applicable if listType is ordered.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "Discriminator value: list",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "items"
+ ],
+ "type": "object"
+ },
+ "paragraph": {
+ "additionalProperties": false,
+ "properties": {
+ "formattedText": {
+ "description": "The formatted content of the paragraph.",
+ "items": {
+ "$ref": "#/$defs/ParagraphBlockTextSection"
+ },
+ "type": "array"
+ },
+ "plaintext": {
+ "description": "The plaintext content of the paragraph.",
+ "type": "string"
+ },
+ "textAlign": {
+ "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "textAlignment": {
+ "description": "The text alignment of the paragraph (e.g., left, center, right).",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: paragraph",
+ "enum": [
+ "paragraph"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ "paywall_break": {
+ "additionalProperties": false,
+ "properties": {
+ "paywall_id": {
+ "description": "The ID of the paywall.",
+ "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
+ "title": "PaywallId",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: paywall_break",
+ "enum": [
+ "paywall_break"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "paywall_id"
+ ],
+ "type": "object"
+ },
+ "poll": {
+ "additionalProperties": false,
+ "properties": {
+ "poll_id": {
+ "description": "The ID of the poll you wish to include.",
+ "pattern": "^(poll_[0-9a-fA-F\\-]+)$",
+ "title": "PollId",
+ "type": "string"
+ },
+ "show_options_initially": {
+ "description": "Whether to show the poll options initially. Defaults to false.",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Discriminator value: poll",
+ "enum": [
+ "poll"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "poll_id"
+ ],
+ "type": "object"
+ },
+ "quote": {
+ "additionalProperties": false,
+ "properties": {
+ "alignment": {
+ "description": "The text alignment of the quote. Defaults depend on the variant.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "author": {
+ "description": "The author of the quote.",
+ "type": "string"
+ },
+ "quote": {
+ "description": "The text of the quote.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Discriminator value: quote",
+ "enum": [
+ "quote"
+ ],
+ "type": "string"
+ },
+ "variant": {
+ "description": "The type of quote block. Defaults to \"block\".",
+ "enum": [
+ "block",
+ "inline",
+ "quotation"
+ ],
+ "title": "QuoteVariant",
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "quote"
+ ],
+ "type": "object"
+ },
+ "rss": {
+ "additionalProperties": false,
+ "properties": {
+ "articleLayout": {
+ "description": "The layout of the articles from the feed.",
+ "enum": [
+ "1-col",
+ "2-col",
+ "3-col",
+ "4-col"
+ ],
+ "title": "RssBlockLayout",
+ "type": "string"
+ },
+ "articlesToShow": {
+ "description": "The number of articles to show from the feed.",
+ "type": "integer"
+ },
+ "ctaAlignment": {
+ "description": "The alignment of the call to action.",
+ "enum": [
+ "Left",
+ "Center",
+ "Right"
+ ],
+ "title": "RssCtaAlignment",
+ "type": "string"
+ },
+ "ctaStyle": {
+ "description": "The style of the call to action.",
+ "enum": [
+ "CTA button",
+ "CTA link",
+ "Title as link",
+ "Thumbnail as link",
+ "Title and thumbnail as link"
+ ],
+ "title": "RssCtaStyle",
+ "type": "string"
+ },
+ "ctaText": {
+ "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
+ "type": "string"
+ },
+ "externalRssFeedId": {
+ "description": "The ID of the external RSS feed.",
+ "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
+ "title": "ExternalRssFeedId",
+ "type": "string"
+ },
+ "refreshOnSend": {
+ "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
+ "type": "boolean"
+ },
+ "rssFeedUrl": {
+ "description": "The URL of the RSS feed.",
+ "type": "string"
+ },
+ "selectionMode": {
+ "description": "How to select feed articles, by count or time window.",
+ "enum": [
+ "count",
+ "time"
+ ],
+ "title": "RssSelectionMode",
+ "type": "string"
+ },
+ "showArticleThumbnail": {
+ "description": "Whether to show the article thumbnail.",
+ "type": "boolean"
+ },
+ "showArticleTitle": {
+ "description": "Whether to show the article title.",
+ "type": "boolean"
+ },
+ "showAuthor": {
+ "description": "Whether to show the author.",
+ "type": "boolean"
+ },
+ "showCategories": {
+ "description": "Whether to show the categories.",
+ "type": "boolean"
+ },
+ "showContent": {
+ "description": "Whether to show the article content.",
+ "type": "boolean"
+ },
+ "showCta": {
+ "description": "Whether to show a call to action.",
+ "type": "boolean"
+ },
+ "showDescription": {
+ "description": "Whether to show the article description.",
+ "type": "boolean"
+ },
+ "showPublishedDate": {
+ "description": "Whether to show the date the article was published",
+ "type": "boolean"
+ },
+ "thumbnailPosition": {
+ "description": "The position of the thumbnail.",
+ "enum": [
+ "Above Title",
+ "Below Title",
+ "Left of content",
+ "Right of content",
+ "Alternating Horizontally"
+ ],
+ "title": "RssThumbnailPosition",
+ "type": "string"
+ },
+ "timeWindowHours": {
+ "description": "Trailing window in hours when selectionMode is time.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "Discriminator value: rss",
+ "enum": [
+ "rss"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ "table": {
+ "additionalProperties": false,
+ "properties": {
+ "headerColumn": {
+ "default": false,
+ "description": "Whether the first column is a header column.",
+ "type": "boolean"
+ },
+ "headerRow": {
+ "default": true,
+ "description": "Whether the first row is a header row.",
+ "type": "boolean"
+ },
+ "rows": {
+ "description": "The rows of the table.",
+ "items": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "alignment": {
+ "description": "The text alignment of the cell.",
+ "enum": [
+ "left",
+ "center",
+ "right"
+ ],
+ "title": "TextAlignment",
+ "type": "string"
+ },
+ "colspan": {
+ "default": 1,
+ "description": "The number of columns the cell spans.",
+ "type": "integer"
+ },
+ "formattedText": {
+ "description": "The formatted content of the cell.",
+ "items": {
+ "$ref": "#/$defs/ParagraphBlockTextSection"
+ },
+ "type": "array"
+ },
+ "rowspan": {
+ "default": 1,
+ "description": "The number of rows the cell spans.",
+ "type": "integer"
+ },
+ "text": {
+ "description": "The text content of the cell.",
+ "type": "string"
+ }
+ },
+ "title": "TableCellData",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Discriminator value: table",
+ "enum": [
+ "table"
+ ],
+ "type": "string"
+ },
+ "visibility_settings": {
+ "$ref": "#/$defs/VisibilitySettings"
+ },
+ "visual_settings": {
+ "$ref": "#/$defs/VisualSettings"
+ }
+ },
+ "required": [
+ "type",
+ "rows"
+ ],
+ "type": "object"
+ },
+ "team_author_ids": {
+ "description": "The prefixed IDs of the team members to associate with this post as authors. Team authors must have access to the publication. When provided, replaces all existing team authors on the post.",
+ "items": {
+ "description": "The prefixed ID of the team author (platform user).",
+ "pattern": "^(user_[0-9a-fA-F\\-]+)$",
+ "title": "TeamAuthorId",
+ "type": "string"
+ },
+ "type": "array"
+ }
+}
addedInput schema / properties / blocks / $ref
Added value: +"#/$defs/blocks"
removedInput schema / properties / blocks / description
Removed value: -"The structured content blocks for the post. How these interact with existing content depends on `content_merge_strategy` (default: full replacement). Supports block types such as paragraph, image, heading, button, html, table, list, columns, and more. Cannot be provided together with `body_content`."
removedInput schema / properties / blocks / items
Removed value: -{
- "description": "A block in the post content.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "advertisement_kind": {
- "description": "The automated advertisement kind to fill at publish time.",
- "enum": [
- "primary",
- "secondary"
- ],
- "title": "AutomatedAdvertisementKind",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: automated_advertisement_placement",
- "enum": [
- "automated_advertisement_placement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "advertisement_kind"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "override_align": {
- "description": "The logo alignment. Defaults to center.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "override_sponsor_text": {
- "description": "The sponsor text to display with the advertisement logo. Required.",
- "enum": [
- "sponsored_by",
- "together_with",
- "in_partnership_with",
- "presented_by",
- "todays_sponsor"
- ],
- "title": "ProgrammaticAdsSponsorText",
- "type": "string"
- },
- "override_width": {
- "description": "The logo width as a percentage. Must be greater than 0. Defaults to 100.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: programmatic_ads_logo",
- "enum": [
- "programmatic_ads_logo"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "override_sponsor_text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "columns": {
- "description": "The blocks that make up the columns.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "blocks": {
- "description": "The blocks that make up the column.",
- "items": {
- "description": "A block in the post content that can be embedded within a column.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- }
- ],
- "title": "EmbeddableBlocks"
- },
- "type": "array"
- },
- "position": {
- "description": "The column position. This field is deprecated but supported for existing column layouts.",
- "enum": [
- "left",
- "right"
- ],
- "title": "ColumnPosition",
- "type": "string"
- },
- "verticalAlign": {
- "description": "The vertical alignment of the column content.",
- "enum": [
- "top",
- "middle",
- "bottom"
- ],
- "title": "ColumnVerticalAlignment",
- "type": "string"
- },
- "width": {
- "description": "The column width percentage. When omitted, width is calculated automatically.",
- "type": "integer"
- }
- },
- "required": [
- "blocks"
- ],
- "title": "ColumnBlock",
- "type": "object"
- },
- "type": "array"
- },
- "stackOnMobile": {
- "default": true,
- "description": "Whether columns should stack vertically on mobile devices.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: columns",
- "enum": [
- "columns"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "columns"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "items": {
- "description": "The items in the list.",
- "items": {
- "description": "A list item as either plain text or formatted text data.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the list item.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "text": {
- "description": "The plain text content of the list item.",
- "type": "string"
- }
- },
- "title": "ListBlockItemData",
- "type": "object"
- }
- ],
- "title": "ListBlockItem"
- },
- "type": "array"
- },
- "listType": {
- "description": "The type of list (e.g., ordered, unordered).",
- "enum": [
- "ordered",
- "unordered"
- ],
- "title": "ListType",
- "type": "string"
- },
- "startNumber": {
- "description": "The number to start the list at. Only applicable if listType is ordered.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: list",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "items"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "headerColumn": {
- "default": false,
- "description": "Whether the first column is a header column.",
- "type": "boolean"
- },
- "headerRow": {
- "default": true,
- "description": "Whether the first row is a header row.",
- "type": "boolean"
- },
- "rows": {
- "description": "The rows of the table.",
- "items": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the cell.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "colspan": {
- "default": 1,
- "description": "The number of columns the cell spans.",
- "type": "integer"
- },
- "formattedText": {
- "description": "The formatted content of the cell.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "rowspan": {
- "default": 1,
- "description": "The number of rows the cell spans.",
- "type": "integer"
- },
- "text": {
- "description": "The text content of the cell.",
- "type": "string"
- }
- },
- "title": "TableCellData",
- "type": "object"
- },
- "type": "array"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: table",
- "enum": [
- "table"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "rows"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "html": {
- "description": "The raw HTML content. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: html",
- "enum": [
- "html"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "html"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: embed_link",
- "enum": [
- "embed_link"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL of the embed link.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "url"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "poll_id": {
- "description": "The ID of the poll you wish to include.",
- "pattern": "^(poll_[0-9a-fA-F\\-]+)$",
- "title": "PollId",
- "type": "string"
- },
- "show_options_initially": {
- "description": "Whether to show the poll options initially. Defaults to false.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: poll",
- "enum": [
- "poll"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "poll_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the quote. Defaults depend on the variant.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "author": {
- "description": "The author of the quote.",
- "type": "string"
- },
- "quote": {
- "description": "The text of the quote.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: quote",
- "enum": [
- "quote"
- ],
- "type": "string"
- },
- "variant": {
- "description": "The type of quote block. Defaults to \"block\".",
- "enum": [
- "block",
- "inline",
- "quotation"
- ],
- "title": "QuoteVariant",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "quote"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: content_break",
- "enum": [
- "content_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "paywall_id": {
- "description": "The ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paywall_break",
- "enum": [
- "paywall_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "paywall_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "blocks": {
- "description": "The blocks to group inside this section. Must contain at least one block. Cannot contain `section` or `columns` blocks.",
- "items": {
- "description": "A block that can appear inside a section. Excludes `section` and `columns` (TipTap's schema does not allow nested sections).",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "items": {
- "description": "The items in the list.",
- "items": {
- "description": "A list item as either plain text or formatted text data.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the list item.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "text": {
- "description": "The plain text content of the list item.",
- "type": "string"
- }
- },
- "title": "ListBlockItemData",
- "type": "object"
- }
- ],
- "title": "ListBlockItem"
- },
- "type": "array"
- },
- "listType": {
- "description": "The type of list (e.g., ordered, unordered).",
- "enum": [
- "ordered",
- "unordered"
- ],
- "title": "ListType",
- "type": "string"
- },
- "startNumber": {
- "description": "The number to start the list at. Only applicable if listType is ordered.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: list",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "items"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "headerColumn": {
- "default": false,
- "description": "Whether the first column is a header column.",
- "type": "boolean"
- },
- "headerRow": {
- "default": true,
- "description": "Whether the first row is a header row.",
- "type": "boolean"
- },
- "rows": {
- "description": "The rows of the table.",
- "items": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the cell.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "colspan": {
- "default": 1,
- "description": "The number of columns the cell spans.",
- "type": "integer"
- },
- "formattedText": {
- "description": "The formatted content of the cell.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "rowspan": {
- "default": 1,
- "description": "The number of rows the cell spans.",
- "type": "integer"
- },
- "text": {
- "description": "The text content of the cell.",
- "type": "string"
- }
- },
- "title": "TableCellData",
- "type": "object"
- },
- "type": "array"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: table",
- "enum": [
- "table"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "rows"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "html": {
- "description": "The raw HTML content. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: html",
- "enum": [
- "html"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "html"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: embed_link",
- "enum": [
- "embed_link"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL of the embed link.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "url"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "poll_id": {
- "description": "The ID of the poll you wish to include.",
- "pattern": "^(poll_[0-9a-fA-F\\-]+)$",
- "title": "PollId",
- "type": "string"
- },
- "show_options_initially": {
- "description": "Whether to show the poll options initially. Defaults to false.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: poll",
- "enum": [
- "poll"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "poll_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the quote. Defaults depend on the variant.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "author": {
- "description": "The author of the quote.",
- "type": "string"
- },
- "quote": {
- "description": "The text of the quote.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: quote",
- "enum": [
- "quote"
- ],
- "type": "string"
- },
- "variant": {
- "description": "The type of quote block. Defaults to \"block\".",
- "enum": [
- "block",
- "inline",
- "quotation"
- ],
- "title": "QuoteVariant",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "quote"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: content_break",
- "enum": [
- "content_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "paywall_id": {
- "description": "The ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paywall_break",
- "enum": [
- "paywall_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "paywall_id"
- ],
- "type": "object"
- }
- ],
- "title": "SectionableBlock"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: section",
- "enum": [
- "section"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this section is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling applied to the section as a whole (background color, padding, borders, etc.).",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "blocks"
- ],
- "type": "object"
- }
- ],
- "title": "Block"
-}
removedInput schema / properties / blocks / type
Removed value: -"array"
addedInput schema / properties / body_content / $ref
Added value: +"#/$defs/body_content"
removedInput schema / properties / body_content / description
Removed value: -"Raw HTML to replace the post's current content. The HTML is wrapped in an `htmlSnippet` block internally. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling. Cannot be provided together with `blocks`."
removedInput schema / properties / body_content / type
Removed value: -"string"
changedInput schema / properties / confirm / description
Previous value: -"Must be true for every account mutation. Confirms only the user-requested action."New value: +"Set true only when the user asked for exactly this action."
addedInput schema / properties / content_merge_strategy / $ref
Added value: +"#/$defs/ContentMergeStrategy"
removedInput schema / properties / content_merge_strategy / description
Removed value: -"Controls how provided `blocks` interact with the post's existing content. Defaults to `replace`. Use `append_to_template` to preserve template header blocks when updating posts that were created from a template."
removedInput schema / properties / content_merge_strategy / enum
Removed value: -[
- "replace",
- "append_to_template",
- "append",
- "prepend"
-]
removedInput schema / properties / content_merge_strategy / title
Removed value: -"ContentMergeStrategy"
removedInput schema / properties / content_merge_strategy / type
Removed value: -"string"
addedInput schema / properties / email_settings / $ref
Added value: +"#/$defs/PostEmailSettings"
removedInput schema / properties / email_settings / additionalProperties
Removed value: -false
removedInput schema / properties / email_settings / description
Removed value: -"The email settings to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / email_settings / properties
Removed value: -{
- "custom_live_url": {
- "type": "string"
- },
- "display_byline_in_email": {
- "type": "boolean"
- },
- "display_subtitle_in_email": {
- "type": "boolean"
- },
- "display_title_in_email": {
- "type": "boolean"
- },
- "email_header_engagement_buttons": {
- "type": "string"
- },
- "email_header_social_share": {
- "type": "string"
- },
- "email_preview_text": {
- "type": "string"
- },
- "email_subject_line": {
- "type": "string"
- },
- "from_address": {
- "type": "string"
- },
- "reply_to_address": {
- "description": "Email address to set as Reply-To. Must be a verified reply-to address owned by the publication. Returns 422 if not found.",
- "type": "string"
- },
- "sender_name": {
- "description": "The sender name preset, expressed as a composition key: either a single token, or ` | | `. Tokens are `brand`, `list`, `authors_first` and `authors_full`; connectors are `from`, `with`, `by`, `at`, `comma`, `colon` and `space`. For a post by Jane Doe on the publication Bee Informed, `authors_first|from|brand` renders as \"Jane from Bee Informed\". The `list` token only resolves when the post is associated with a newsletter list. Pass `null` to clear the override and inherit from the newsletter list or publication.",
- "pattern": "^(brand|list|authors_first|authors_full)(\\|(from|with|by|at|comma|colon|space)\\|(brand|list|authors_first|authors_full))?$",
- "type": "string"
- }
-}
removedInput schema / properties / email_settings / title
Removed value: -"PostEmailSettings"
removedInput schema / properties / email_settings / type
Removed value: -"object"
addedInput schema / properties / guest_author_ids / $ref
Added value: +"#/$defs/guest_author_ids"
removedInput schema / properties / guest_author_ids / description
Removed value: -"The prefixed IDs of the guest authors to associate with this post. Guest authors must belong to the publication. When provided, replaces all existing guest authors on the post."
removedInput schema / properties / guest_author_ids / items
Removed value: -{
- "description": "The prefixed ID of the guest author.",
- "pattern": "^(guest_[0-9a-fA-F\\-]+)$",
- "title": "GuestAuthorId",
- "type": "string"
-}
removedInput schema / properties / guest_author_ids / type
Removed value: -"array"
addedInput schema / properties / headers / $ref
Added value: +"#/$defs/headers"
removedInput schema / properties / headers / additionalProperties
Removed value: -{
- "type": [
- "string",
- "null"
- ]
-}
removedInput schema / properties / headers / description
Removed value: -"Custom email headers for this post. Merges with newsletter list and publication headers at send time, with this post's values winning on a key collision. Set a value to `null` to suppress a header inherited from the newsletter list or publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden."
removedInput schema / properties / headers / type
Removed value: -"object"
addedInput schema / properties / payload / properties / blocks / $ref
Added value: +"#/$defs/blocks"
removedInput schema / properties / payload / properties / blocks / description
Removed value: -"The structured content blocks for the post. How these interact with existing content depends on `content_merge_strategy` (default: full replacement). Supports block types such as paragraph, image, heading, button, html, table, list, columns, and more. Cannot be provided together with `body_content`."
removedInput schema / properties / payload / properties / blocks / items
Removed value: -{
- "description": "A block in the post content.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "advertisement_kind": {
- "description": "The automated advertisement kind to fill at publish time.",
- "enum": [
- "primary",
- "secondary"
- ],
- "title": "AutomatedAdvertisementKind",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: automated_advertisement_placement",
- "enum": [
- "automated_advertisement_placement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "advertisement_kind"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "override_align": {
- "description": "The logo alignment. Defaults to center.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "override_sponsor_text": {
- "description": "The sponsor text to display with the advertisement logo. Required.",
- "enum": [
- "sponsored_by",
- "together_with",
- "in_partnership_with",
- "presented_by",
- "todays_sponsor"
- ],
- "title": "ProgrammaticAdsSponsorText",
- "type": "string"
- },
- "override_width": {
- "description": "The logo width as a percentage. Must be greater than 0. Defaults to 100.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: programmatic_ads_logo",
- "enum": [
- "programmatic_ads_logo"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "override_sponsor_text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "columns": {
- "description": "The blocks that make up the columns.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "blocks": {
- "description": "The blocks that make up the column.",
- "items": {
- "description": "A block in the post content that can be embedded within a column.",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- }
- ],
- "title": "EmbeddableBlocks"
- },
- "type": "array"
- },
- "position": {
- "description": "The column position. This field is deprecated but supported for existing column layouts.",
- "enum": [
- "left",
- "right"
- ],
- "title": "ColumnPosition",
- "type": "string"
- },
- "verticalAlign": {
- "description": "The vertical alignment of the column content.",
- "enum": [
- "top",
- "middle",
- "bottom"
- ],
- "title": "ColumnVerticalAlignment",
- "type": "string"
- },
- "width": {
- "description": "The column width percentage. When omitted, width is calculated automatically.",
- "type": "integer"
- }
- },
- "required": [
- "blocks"
- ],
- "title": "ColumnBlock",
- "type": "object"
- },
- "type": "array"
- },
- "stackOnMobile": {
- "default": true,
- "description": "Whether columns should stack vertically on mobile devices.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: columns",
- "enum": [
- "columns"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "columns"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "items": {
- "description": "The items in the list.",
- "items": {
- "description": "A list item as either plain text or formatted text data.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the list item.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "text": {
- "description": "The plain text content of the list item.",
- "type": "string"
- }
- },
- "title": "ListBlockItemData",
- "type": "object"
- }
- ],
- "title": "ListBlockItem"
- },
- "type": "array"
- },
- "listType": {
- "description": "The type of list (e.g., ordered, unordered).",
- "enum": [
- "ordered",
- "unordered"
- ],
- "title": "ListType",
- "type": "string"
- },
- "startNumber": {
- "description": "The number to start the list at. Only applicable if listType is ordered.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: list",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "items"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "headerColumn": {
- "default": false,
- "description": "Whether the first column is a header column.",
- "type": "boolean"
- },
- "headerRow": {
- "default": true,
- "description": "Whether the first row is a header row.",
- "type": "boolean"
- },
- "rows": {
- "description": "The rows of the table.",
- "items": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the cell.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "colspan": {
- "default": 1,
- "description": "The number of columns the cell spans.",
- "type": "integer"
- },
- "formattedText": {
- "description": "The formatted content of the cell.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "rowspan": {
- "default": 1,
- "description": "The number of rows the cell spans.",
- "type": "integer"
- },
- "text": {
- "description": "The text content of the cell.",
- "type": "string"
- }
- },
- "title": "TableCellData",
- "type": "object"
- },
- "type": "array"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: table",
- "enum": [
- "table"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "rows"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "html": {
- "description": "The raw HTML content. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: html",
- "enum": [
- "html"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "html"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: embed_link",
- "enum": [
- "embed_link"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL of the embed link.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "url"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "poll_id": {
- "description": "The ID of the poll you wish to include.",
- "pattern": "^(poll_[0-9a-fA-F\\-]+)$",
- "title": "PollId",
- "type": "string"
- },
- "show_options_initially": {
- "description": "Whether to show the poll options initially. Defaults to false.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: poll",
- "enum": [
- "poll"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "poll_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the quote. Defaults depend on the variant.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "author": {
- "description": "The author of the quote.",
- "type": "string"
- },
- "quote": {
- "description": "The text of the quote.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: quote",
- "enum": [
- "quote"
- ],
- "type": "string"
- },
- "variant": {
- "description": "The type of quote block. Defaults to \"block\".",
- "enum": [
- "block",
- "inline",
- "quotation"
- ],
- "title": "QuoteVariant",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "quote"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: content_break",
- "enum": [
- "content_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "paywall_id": {
- "description": "The ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paywall_break",
- "enum": [
- "paywall_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "paywall_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "blocks": {
- "description": "The blocks to group inside this section. Must contain at least one block. Cannot contain `section` or `columns` blocks.",
- "items": {
- "description": "A block that can appear inside a section. Excludes `section` and `columns` (TipTap's schema does not allow nested sections).",
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the paragraph.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "plaintext": {
- "description": "The plaintext content of the paragraph.",
- "type": "string"
- },
- "textAlign": {
- "description": "Legacy paragraph alignment field. Use `textAlignment` for new integrations.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the paragraph (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paragraph",
- "enum": [
- "paragraph"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alt_text": {
- "description": "Alternative text for the image.",
- "type": "string"
- },
- "caption": {
- "description": "A caption for the image.",
- "type": "string"
- },
- "captionAlignment": {
- "description": "The text alignment of the caption.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageAlignment": {
- "description": "The text alignment of the image.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "title": {
- "description": "The title of the image.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: image",
- "enum": [
- "image"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL that the image should link to.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- },
- "width": {
- "description": "The width of the image. Should be between 1 and 100.",
- "type": "integer"
- }
- },
- "required": [
- "type",
- "imageUrl"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the button.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "href": {
- "description": "The URL the button should use.",
- "type": "string"
- },
- "size": {
- "description": "The size of the button (e.g., small, normal, large).",
- "enum": [
- "small",
- "normal",
- "large"
- ],
- "title": "Sizes",
- "type": "string"
- },
- "target": {
- "description": "The target of the button (e.g., _blank).",
- "type": "string"
- },
- "text": {
- "description": "The text content of the button.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: button",
- "enum": [
- "button"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "href",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "anchorHeader": {
- "default": true,
- "description": "Whether the header should be an anchor header.",
- "type": "boolean"
- },
- "anchorIncludeInToc": {
- "default": true,
- "description": "Whether the header should be included in the table of contents.",
- "type": "boolean"
- },
- "formattedText": {
- "description": "The formatted content of the header, supporting links and inline styling.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "level": {
- "description": "The level of the header (e.g., 1, 2, 3, etc.).",
- "enum": [
- "1",
- "2",
- "3",
- "4",
- "5",
- "6"
- ],
- "title": "HeadingLevel",
- "type": "string"
- },
- "text": {
- "description": "The text content of the header. Ignored if `formattedText` is provided.",
- "type": "string"
- },
- "textAlignment": {
- "description": "The text alignment of the header (e.g., left, center, right).",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: heading",
- "enum": [
- "heading"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "level"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "articleLayout": {
- "description": "The layout of the articles from the feed.",
- "enum": [
- "1-col",
- "2-col",
- "3-col",
- "4-col"
- ],
- "title": "RssBlockLayout",
- "type": "string"
- },
- "articlesToShow": {
- "description": "The number of articles to show from the feed.",
- "type": "integer"
- },
- "ctaAlignment": {
- "description": "The alignment of the call to action.",
- "enum": [
- "Left",
- "Center",
- "Right"
- ],
- "title": "RssCtaAlignment",
- "type": "string"
- },
- "ctaStyle": {
- "description": "The style of the call to action.",
- "enum": [
- "CTA button",
- "CTA link",
- "Title as link",
- "Thumbnail as link",
- "Title and thumbnail as link"
- ],
- "title": "RssCtaStyle",
- "type": "string"
- },
- "ctaText": {
- "description": "The text of the call to action. Applicable if ctaStyle is button or link.",
- "type": "string"
- },
- "externalRssFeedId": {
- "description": "The ID of the external RSS feed.",
- "pattern": "^(external_rss_[0-9a-fA-F\\-]+)$",
- "title": "ExternalRssFeedId",
- "type": "string"
- },
- "refreshOnSend": {
- "description": "Whether or not to refresh the contents from the RSS feed before sending out the email.",
- "type": "boolean"
- },
- "rssFeedUrl": {
- "description": "The URL of the RSS feed.",
- "type": "string"
- },
- "selectionMode": {
- "description": "How to select feed articles, by count or time window.",
- "enum": [
- "count",
- "time"
- ],
- "title": "RssSelectionMode",
- "type": "string"
- },
- "showArticleThumbnail": {
- "description": "Whether to show the article thumbnail.",
- "type": "boolean"
- },
- "showArticleTitle": {
- "description": "Whether to show the article title.",
- "type": "boolean"
- },
- "showAuthor": {
- "description": "Whether to show the author.",
- "type": "boolean"
- },
- "showCategories": {
- "description": "Whether to show the categories.",
- "type": "boolean"
- },
- "showContent": {
- "description": "Whether to show the article content.",
- "type": "boolean"
- },
- "showCta": {
- "description": "Whether to show a call to action.",
- "type": "boolean"
- },
- "showDescription": {
- "description": "Whether to show the article description.",
- "type": "boolean"
- },
- "showPublishedDate": {
- "description": "Whether to show the date the article was published",
- "type": "boolean"
- },
- "thumbnailPosition": {
- "description": "The position of the thumbnail.",
- "enum": [
- "Above Title",
- "Below Title",
- "Left of content",
- "Right of content",
- "Alternating Horizontally"
- ],
- "title": "RssThumbnailPosition",
- "type": "string"
- },
- "timeWindowHours": {
- "description": "Trailing window in hours when selectionMode is time.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: rss",
- "enum": [
- "rss"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "opportunity_id": {
- "description": "The ID of the Advertisement opportunity.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: advertisement",
- "enum": [
- "advertisement"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "opportunity_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "items": {
- "description": "The items in the list.",
- "items": {
- "description": "A list item as either plain text or formatted text data.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": false,
- "properties": {
- "formattedText": {
- "description": "The formatted content of the list item.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "text": {
- "description": "The plain text content of the list item.",
- "type": "string"
- }
- },
- "title": "ListBlockItemData",
- "type": "object"
- }
- ],
- "title": "ListBlockItem"
- },
- "type": "array"
- },
- "listType": {
- "description": "The type of list (e.g., ordered, unordered).",
- "enum": [
- "ordered",
- "unordered"
- ],
- "title": "ListType",
- "type": "string"
- },
- "startNumber": {
- "description": "The number to start the list at. Only applicable if listType is ordered.",
- "type": "integer"
- },
- "type": {
- "description": "Discriminator value: list",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "items"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "headerColumn": {
- "default": false,
- "description": "Whether the first column is a header column.",
- "type": "boolean"
- },
- "headerRow": {
- "default": true,
- "description": "Whether the first row is a header row.",
- "type": "boolean"
- },
- "rows": {
- "description": "The rows of the table.",
- "items": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the cell.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "colspan": {
- "default": 1,
- "description": "The number of columns the cell spans.",
- "type": "integer"
- },
- "formattedText": {
- "description": "The formatted content of the cell.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "highlight_color": {
- "description": "The CSS color value for the text highlight.",
- "type": "string"
- },
- "link": {
- "additionalProperties": false,
- "description": "The link of the text.",
- "properties": {
- "href": {
- "description": "The URL of the link.",
- "type": "string"
- },
- "target": {
- "description": "The target of the link (e.g., _blank).",
- "type": "string"
- }
- },
- "required": [
- "href"
- ],
- "title": "Link",
- "type": "object"
- },
- "styling": {
- "description": "The inline styles for the text.",
- "items": {
- "description": "Inline formatting to apply to a formatted text section. `strikethrough` renders as a strike mark.",
- "enum": [
- "bold",
- "italic",
- "underline",
- "strikethrough"
- ],
- "title": "ParagraphBlockTextStyle",
- "type": "string"
- },
- "type": "array"
- },
- "text": {
- "description": "The text content of the paragraph.",
- "type": "string"
- },
- "text_color": {
- "description": "The CSS color value for the text.",
- "type": "string"
- }
- },
- "required": [
- "text"
- ],
- "title": "ParagraphBlockTextSection",
- "type": "object"
- },
- "type": "array"
- },
- "rowspan": {
- "default": 1,
- "description": "The number of rows the cell spans.",
- "type": "integer"
- },
- "text": {
- "description": "The text content of the cell.",
- "type": "string"
- }
- },
- "title": "TableCellData",
- "type": "object"
- },
- "type": "array"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: table",
- "enum": [
- "table"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "rows"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "html": {
- "description": "The raw HTML content. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: html",
- "enum": [
- "html"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "html"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: embed_link",
- "enum": [
- "embed_link"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL of the embed link.",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "url"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "poll_id": {
- "description": "The ID of the poll you wish to include.",
- "pattern": "^(poll_[0-9a-fA-F\\-]+)$",
- "title": "PollId",
- "type": "string"
- },
- "show_options_initially": {
- "description": "Whether to show the poll options initially. Defaults to false.",
- "type": "boolean"
- },
- "type": {
- "description": "Discriminator value: poll",
- "enum": [
- "poll"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "poll_id"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "alignment": {
- "description": "The text alignment of the quote. Defaults depend on the variant.",
- "enum": [
- "left",
- "center",
- "right"
- ],
- "title": "TextAlignment",
- "type": "string"
- },
- "author": {
- "description": "The author of the quote.",
- "type": "string"
- },
- "quote": {
- "description": "The text of the quote.",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: quote",
- "enum": [
- "quote"
- ],
- "type": "string"
- },
- "variant": {
- "description": "The type of quote block. Defaults to \"block\".",
- "enum": [
- "block",
- "inline",
- "quotation"
- ],
- "title": "QuoteVariant",
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this block is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling for borders, spacing, colors, etc.",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "quote"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "type": {
- "description": "Discriminator value: content_break",
- "enum": [
- "content_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "paywall_id": {
- "description": "The ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "type": {
- "description": "Discriminator value: paywall_break",
- "enum": [
- "paywall_break"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "paywall_id"
- ],
- "type": "object"
- }
- ],
- "title": "SectionableBlock"
- },
- "type": "array"
- },
- "type": {
- "description": "Discriminator value: section",
- "enum": [
- "section"
- ],
- "type": "string"
- },
- "visibility_settings": {
- "additionalProperties": false,
- "description": "Optional rules for when/where this section is shown, including dynamic content targeting via condition sets.",
- "properties": {
- "condition_set_ids": {
- "description": "An optional list of condition set UUIDs to gate this block behind dynamic content targeting. When provided, only subscribers matching the specified condition sets will see this block. Condition sets must belong to the same publication and be active.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "condition_set_operator": {
- "description": "Instructs how to combine multiple condition sets. Defaults to \"or\" (subscriber can match any condition). Use \"and\" to show the block if the subscriber meets all conditions.",
- "enum": [
- "and",
- "or"
- ],
- "title": "ConditionSetOperator",
- "type": "string"
- },
- "show_on_email": {
- "description": "Whether to show the block on the email.",
- "type": "boolean"
- },
- "show_on_web": {
- "description": "Whether to show the block on the web.",
- "type": "boolean"
- },
- "show_to_anonymous_users_web": {
- "description": "Whether to show the block to anonymous users on the web.",
- "type": "boolean"
- },
- "show_to_free_subscribers": {
- "description": "Whether to show the block to free subscribers.",
- "type": "boolean"
- },
- "show_to_paid_subscribers": {
- "description": "Whether to show the block to paid subscribers.",
- "type": "boolean"
- },
- "show_to_subscribers_with_referral_condition": {
- "description": "The condition required to show the block to subscribers.",
- "enum": [
- "eq",
- "gt",
- "lt"
- ],
- "title": "ReferralCondition",
- "type": "string"
- },
- "show_to_subscribers_with_referral_value": {
- "description": "The exact referral count required to show the block to subscribers.",
- "type": "integer"
- }
- },
- "title": "VisibilitySettings",
- "type": "object"
- },
- "visual_settings": {
- "additionalProperties": false,
- "description": "Optional styling applied to the section as a whole (background color, padding, borders, etc.).",
- "properties": {
- "background_color": {
- "description": "The background color of the block.",
- "type": "string"
- },
- "border_color": {
- "description": "The border color of the block.",
- "type": "string"
- },
- "border_radius": {
- "description": "The border radius of the block.",
- "type": "integer"
- },
- "border_radius_bottom_left": {
- "description": "The border radius of the bottom left of the block.",
- "type": "integer"
- },
- "border_radius_bottom_right": {
- "description": "The border radius of the bottom right of the block.",
- "type": "integer"
- },
- "border_radius_top_left": {
- "description": "The border radius of the top left of the block.",
- "type": "integer"
- },
- "border_radius_top_right": {
- "description": "The border radius of the top right of the block.",
- "type": "integer"
- },
- "border_style": {
- "description": "The border style of the block.",
- "enum": [
- "solid",
- "dashed",
- "dotted"
- ],
- "title": "BorderStyle",
- "type": "string"
- },
- "border_width": {
- "description": "The border width of the block.",
- "type": "integer"
- },
- "border_width_bottom": {
- "description": "The border width of the bottom of the block.",
- "type": "integer"
- },
- "border_width_left": {
- "description": "The border width of the left of the block.",
- "type": "integer"
- },
- "border_width_right": {
- "description": "The border width of the right of the block.",
- "type": "integer"
- },
- "border_width_top": {
- "description": "The border width of the top of the block.",
- "type": "integer"
- },
- "inner_spacing": {
- "description": "The inner spacing of the block.",
- "type": "integer"
- },
- "inner_spacing_bottom": {
- "description": "The inner spacing of the bottom of the block.",
- "type": "integer"
- },
- "inner_spacing_left": {
- "description": "The inner spacing of the left of the block.",
- "type": "integer"
- },
- "inner_spacing_right": {
- "description": "The inner spacing of the right of the block.",
- "type": "integer"
- },
- "inner_spacing_top": {
- "description": "The inner spacing of the top of the block.",
- "type": "integer"
- },
- "outer_spacing": {
- "description": "The outer spacing of the block.",
- "type": "integer"
- },
- "outer_spacing_bottom": {
- "description": "The outer spacing of the bottom of the block.",
- "type": "integer"
- },
- "outer_spacing_left": {
- "description": "The outer spacing of the left of the block.",
- "type": "integer"
- },
- "outer_spacing_right": {
- "description": "The outer spacing of the right of the block.",
- "type": "integer"
- },
- "outer_spacing_top": {
- "description": "The outer spacing of the top of the block.",
- "type": "integer"
- },
- "text_color": {
- "description": "The text color of the block.",
- "type": "string"
- }
- },
- "title": "VisualSettings",
- "type": "object"
- }
- },
- "required": [
- "type",
- "blocks"
- ],
- "type": "object"
- }
- ],
- "title": "Block"
-}
removedInput schema / properties / payload / properties / blocks / type
Removed value: -"array"
addedInput schema / properties / payload / properties / body_content / $ref
Added value: +"#/$defs/body_content"
removedInput schema / properties / payload / properties / body_content / description
Removed value: -"Raw HTML to replace the post's current content. The HTML is wrapped in an `htmlSnippet` block internally. Note that ` ` and ` ` tags are removed during sanitization : use inline styles for all visual styling. Cannot be provided together with `blocks`."
removedInput schema / properties / payload / properties / body_content / type
Removed value: -"string"
addedInput schema / properties / payload / properties / content_merge_strategy / $ref
Added value: +"#/$defs/ContentMergeStrategy"
removedInput schema / properties / payload / properties / content_merge_strategy / description
Removed value: -"Controls how provided `blocks` interact with the post's existing content. Defaults to `replace`. Use `append_to_template` to preserve template header blocks when updating posts that were created from a template."
removedInput schema / properties / payload / properties / content_merge_strategy / enum
Removed value: -[
- "replace",
- "append_to_template",
- "append",
- "prepend"
-]
removedInput schema / properties / payload / properties / content_merge_strategy / title
Removed value: -"ContentMergeStrategy"
removedInput schema / properties / payload / properties / content_merge_strategy / type
Removed value: -"string"
addedInput schema / properties / payload / properties / email_settings / $ref
Added value: +"#/$defs/PostEmailSettings"
removedInput schema / properties / payload / properties / email_settings / additionalProperties
Removed value: -false
removedInput schema / properties / payload / properties / email_settings / description
Removed value: -"The email settings to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / payload / properties / email_settings / properties
Removed value: -{
- "custom_live_url": {
- "type": "string"
- },
- "display_byline_in_email": {
- "type": "boolean"
- },
- "display_subtitle_in_email": {
- "type": "boolean"
- },
- "display_title_in_email": {
- "type": "boolean"
- },
- "email_header_engagement_buttons": {
- "type": "string"
- },
- "email_header_social_share": {
- "type": "string"
- },
- "email_preview_text": {
- "type": "string"
- },
- "email_subject_line": {
- "type": "string"
- },
- "from_address": {
- "type": "string"
- },
- "reply_to_address": {
- "description": "Email address to set as Reply-To. Must be a verified reply-to address owned by the publication. Returns 422 if not found.",
- "type": "string"
- },
- "sender_name": {
- "description": "The sender name preset, expressed as a composition key: either a single token, or ` | | `. Tokens are `brand`, `list`, `authors_first` and `authors_full`; connectors are `from`, `with`, `by`, `at`, `comma`, `colon` and `space`. For a post by Jane Doe on the publication Bee Informed, `authors_first|from|brand` renders as \"Jane from Bee Informed\". The `list` token only resolves when the post is associated with a newsletter list. Pass `null` to clear the override and inherit from the newsletter list or publication.",
- "pattern": "^(brand|list|authors_first|authors_full)(\\|(from|with|by|at|comma|colon|space)\\|(brand|list|authors_first|authors_full))?$",
- "type": "string"
- }
-}
removedInput schema / properties / payload / properties / email_settings / title
Removed value: -"PostEmailSettings"
removedInput schema / properties / payload / properties / email_settings / type
Removed value: -"object"
addedInput schema / properties / payload / properties / guest_author_ids / $ref
Added value: +"#/$defs/guest_author_ids"
removedInput schema / properties / payload / properties / guest_author_ids / description
Removed value: -"The prefixed IDs of the guest authors to associate with this post. Guest authors must belong to the publication. When provided, replaces all existing guest authors on the post."
removedInput schema / properties / payload / properties / guest_author_ids / items
Removed value: -{
- "description": "The prefixed ID of the guest author.",
- "pattern": "^(guest_[0-9a-fA-F\\-]+)$",
- "title": "GuestAuthorId",
- "type": "string"
-}
removedInput schema / properties / payload / properties / guest_author_ids / type
Removed value: -"array"
addedInput schema / properties / payload / properties / headers / $ref
Added value: +"#/$defs/headers"
removedInput schema / properties / payload / properties / headers / additionalProperties
Removed value: -{
- "type": [
- "string",
- "null"
- ]
-}
removedInput schema / properties / payload / properties / headers / description
Removed value: -"Custom email headers for this post. Merges with newsletter list and publication headers at send time, with this post's values winning on a key collision. Set a value to `null` to suppress a header inherited from the newsletter list or publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden."
removedInput schema / properties / payload / properties / headers / type
Removed value: -"object"
addedInput schema / properties / payload / properties / recipients / $ref
Added value: +"#/$defs/PostRecipients"
removedInput schema / properties / payload / properties / recipients / additionalProperties
Removed value: -false
removedInput schema / properties / payload / properties / recipients / description
Removed value: -"The recipients for this post. When provided, replaces all existing web and email audience targets with the specified values. If omitted, existing targets are unchanged."
removedInput schema / properties / payload / properties / recipients / properties
Removed value: -{
- "email": {
- "additionalProperties": false,
- "description": "Email audience targeting. Omit this key to create no email targets.",
- "properties": {
- "exclude_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "include_segment_ids": {
- "description": "Cannot be combined with `tier_ids`.",
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "tier_ids": {
- "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier. Cannot be combined with `include_segment_ids`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "title": "PostEmailRecipients",
- "type": "object"
- },
- "web": {
- "additionalProperties": false,
- "description": "Web audience targeting. Omit this key to create no web targets.",
- "properties": {
- "exclude_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "include_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "tier_ids": {
- "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "title": "PostWebRecipients",
- "type": "object"
- }
-}
removedInput schema / properties / payload / properties / recipients / required
Removed value: -[
- "web",
- "email"
-]
removedInput schema / properties / payload / properties / recipients / title
Removed value: -"PostRecipients"
removedInput schema / properties / payload / properties / recipients / type
Removed value: -"object"
addedInput schema / properties / payload / properties / seo_settings / $ref
Added value: +"#/$defs/PostMetadata"
removedInput schema / properties / payload / properties / seo_settings / additionalProperties
Removed value: -false
removedInput schema / properties / payload / properties / seo_settings / description
Removed value: -"The SEO metadata to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / payload / properties / seo_settings / properties
Removed value: -{
- "default_description": {
- "type": "string"
- },
- "default_title": {
- "type": "string"
- },
- "og_description": {
- "type": "string"
- },
- "og_title": {
- "type": "string"
- },
- "twitter_description": {
- "type": "string"
- },
- "twitter_title": {
- "type": "string"
- }
-}
removedInput schema / properties / payload / properties / seo_settings / title
Removed value: -"PostMetadata"
removedInput schema / properties / payload / properties / seo_settings / type
Removed value: -"object"
addedInput schema / properties / payload / properties / status / $ref
Added value: +"#/$defs/PostPublishStatus"
removedInput schema / properties / payload / properties / status / default
Removed value: -"draft"
removedInput schema / properties / payload / properties / status / description
Removed value: -"Transition the post's status. Use `confirmed` to schedule or publish a draft post. Only the `draft` → `confirmed` transition is supported : a confirmed post cannot be moved back to `draft`."
removedInput schema / properties / payload / properties / status / enum
Removed value: -[
- "draft",
- "confirmed"
-]
removedInput schema / properties / payload / properties / status / title
Removed value: -"PostPublishStatus"
removedInput schema / properties / payload / properties / status / type
Removed value: -"string"
addedInput schema / properties / payload / properties / team_author_ids / $ref
Added value: +"#/$defs/team_author_ids"
removedInput schema / properties / payload / properties / team_author_ids / description
Removed value: -"The prefixed IDs of the team members to associate with this post as authors. Team authors must have access to the publication. When provided, replaces all existing team authors on the post."
removedInput schema / properties / payload / properties / team_author_ids / items
Removed value: -{
- "description": "The prefixed ID of the team author (platform user).",
- "pattern": "^(user_[0-9a-fA-F\\-]+)$",
- "title": "TeamAuthorId",
- "type": "string"
-}
removedInput schema / properties / payload / properties / team_author_ids / type
Removed value: -"array"
addedInput schema / properties / payload / properties / web_settings / $ref
Added value: +"#/$defs/PostWebSettings"
removedInput schema / properties / payload / properties / web_settings / additionalProperties
Removed value: -false
removedInput schema / properties / payload / properties / web_settings / description
Removed value: -"The web settings to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / payload / properties / web_settings / properties
Removed value: -{
- "display_subtitle_on_web": {
- "type": "boolean"
- },
- "display_thumbnail_on_web": {
- "type": "boolean"
- },
- "display_title_on_web": {
- "type": "boolean"
- },
- "hide_from_feed": {
- "type": "boolean"
- },
- "paywall_break_price_id": {
- "description": "The prefixed ID of the price.",
- "pattern": "^(price_[0-9a-fA-F\\-]+)$",
- "title": "PriceId",
- "type": "string"
- },
- "paywall_id": {
- "description": "The prefixed ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "slug": {
- "type": "string"
- }
-}
removedInput schema / properties / payload / properties / web_settings / title
Removed value: -"PostWebSettings"
removedInput schema / properties / payload / properties / web_settings / type
Removed value: -"object"
addedInput schema / properties / recipients / $ref
Added value: +"#/$defs/PostRecipients"
removedInput schema / properties / recipients / additionalProperties
Removed value: -false
removedInput schema / properties / recipients / description
Removed value: -"The recipients for this post. When provided, replaces all existing web and email audience targets with the specified values. If omitted, existing targets are unchanged."
removedInput schema / properties / recipients / properties
Removed value: -{
- "email": {
- "additionalProperties": false,
- "description": "Email audience targeting. Omit this key to create no email targets.",
- "properties": {
- "exclude_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "include_segment_ids": {
- "description": "Cannot be combined with `tier_ids`.",
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "tier_ids": {
- "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier. Cannot be combined with `include_segment_ids`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "title": "PostEmailRecipients",
- "type": "object"
- },
- "web": {
- "additionalProperties": false,
- "description": "Web audience targeting. Omit this key to create no web targets.",
- "properties": {
- "exclude_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "include_segment_ids": {
- "items": {
- "description": "The prefixed ID of the segment.",
- "pattern": "^(seg_[0-9a-fA-F\\-]+)$",
- "title": "SegmentId",
- "type": "string"
- },
- "type": "array"
- },
- "tier_ids": {
- "description": "The tier IDs to target. Accepts specific tier UUIDs or the special values `\"free\"`, `\"premium\"`, or `\"all\"`. When `\"all\"` is provided, targets all subscriber tiers : free subscribers, and premium subscribers if the publication has an active paid tier.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "title": "PostWebRecipients",
- "type": "object"
- }
-}
removedInput schema / properties / recipients / required
Removed value: -[
- "web",
- "email"
-]
removedInput schema / properties / recipients / title
Removed value: -"PostRecipients"
removedInput schema / properties / recipients / type
Removed value: -"object"
addedInput schema / properties / seo_settings / $ref
Added value: +"#/$defs/PostMetadata"
removedInput schema / properties / seo_settings / additionalProperties
Removed value: -false
removedInput schema / properties / seo_settings / description
Removed value: -"The SEO metadata to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / seo_settings / properties
Removed value: -{
- "default_description": {
- "type": "string"
- },
- "default_title": {
- "type": "string"
- },
- "og_description": {
- "type": "string"
- },
- "og_title": {
- "type": "string"
- },
- "twitter_description": {
- "type": "string"
- },
- "twitter_title": {
- "type": "string"
- }
-}
removedInput schema / properties / seo_settings / title
Removed value: -"PostMetadata"
removedInput schema / properties / seo_settings / type
Removed value: -"object"
addedInput schema / properties / status / $ref
Added value: +"#/$defs/PostPublishStatus"
removedInput schema / properties / status / default
Removed value: -"draft"
removedInput schema / properties / status / description
Removed value: -"Transition the post's status. Use `confirmed` to schedule or publish a draft post. Only the `draft` → `confirmed` transition is supported : a confirmed post cannot be moved back to `draft`."
removedInput schema / properties / status / enum
Removed value: -[
- "draft",
- "confirmed"
-]
removedInput schema / properties / status / title
Removed value: -"PostPublishStatus"
removedInput schema / properties / status / type
Removed value: -"string"
addedInput schema / properties / team_author_ids / $ref
Added value: +"#/$defs/team_author_ids"
removedInput schema / properties / team_author_ids / description
Removed value: -"The prefixed IDs of the team members to associate with this post as authors. Team authors must have access to the publication. When provided, replaces all existing team authors on the post."
removedInput schema / properties / team_author_ids / items
Removed value: -{
- "description": "The prefixed ID of the team author (platform user).",
- "pattern": "^(user_[0-9a-fA-F\\-]+)$",
- "title": "TeamAuthorId",
- "type": "string"
-}
removedInput schema / properties / team_author_ids / type
Removed value: -"array"
addedInput schema / properties / web_settings / $ref
Added value: +"#/$defs/PostWebSettings"
removedInput schema / properties / web_settings / additionalProperties
Removed value: -false
removedInput schema / properties / web_settings / description
Removed value: -"The web settings to use for this post. Only the provided fields within this object will be updated."
removedInput schema / properties / web_settings / properties
Removed value: -{
- "display_subtitle_on_web": {
- "type": "boolean"
- },
- "display_thumbnail_on_web": {
- "type": "boolean"
- },
- "display_title_on_web": {
- "type": "boolean"
- },
- "hide_from_feed": {
- "type": "boolean"
- },
- "paywall_break_price_id": {
- "description": "The prefixed ID of the price.",
- "pattern": "^(price_[0-9a-fA-F\\-]+)$",
- "title": "PriceId",
- "type": "string"
- },
- "paywall_id": {
- "description": "The prefixed ID of the paywall.",
- "pattern": "^(paywall_[0-9a-fA-F\\-]+)$",
- "title": "PaywallId",
- "type": "string"
- },
- "slug": {
- "type": "string"
- }
-}
removedInput schema / properties / web_settings / title
Removed value: -"PostWebSettings"
removedInput schema / properties / web_settings / type
Removed value: -"object"
