{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thanks-io/json-schema/thanks-io-message-template-schema.json",
  "title": "message-template",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thanks-io-message-templates-api-openapi.yml#/components/schemas/message-template",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "user_id": {
      "type": "integer"
    },
    "sub_account_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "handwriting_style_id": {
      "type": "integer",
      "description": "ID of the handwriting style used in the message template"
    },
    "font_size": {
      "type": "integer",
      "description": "Font size used in the message template.  Only valid for AI fonts",
      "enum": [
        "auto",
        "large",
        "medium",
        "small"
      ]
    },
    "font_color": {
      "type": "string",
      "description": "Font color used in the message template."
    },
    "handwriting_realism": {
      "type": "boolean",
      "description": "Handwriting realism level used in the message template. Only valid for AI fonts"
    },
    "name": {
      "type": "string"
    },
    "content": {
      "type": "string"
    },
    "additional_pages": {
      "type": "string",
      "format": "uri",
      "description": "URL to additional pages to include with the cover letter. Only valid for letter templates."
    },
    "skip_creative_generation": {
      "type": "integer",
      "description": "Flag to skip creative generation.  Set when message template is PDF file only."
    },
    "custom_background_url": {
      "type": "string",
      "description": "URL of the custom background image for the message template. Only valid for postcard backs and the interior background of notecards and giftcards."
    },
    "qrcode_url": {
      "type": "string",
      "description": "URL of the QR code image for the message template"
    },
    "cc_emails": {
      "type": "array",
      "description": "List of email addresses to be CC'd on when a QR code is scanned",
      "items": {
        "type": "string",
        "format": "email"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "type": {
      "type": "string",
      "enum": [
        "postcard",
        "postcard6x9",
        "postcard6x11",
        "letter",
        "windowlessletter",
        "notecard",
        "giftcard",
        "magnacard"
      ],
      "description": "Type of the message template"
    },
    "giftcard_brand_code": {
      "type": "string",
      "description": "Brand code of the gift card"
    },
    "giftcard_brand_image": {
      "type": "string",
      "description": "Image URL of the gift card brand"
    },
    "giftcard_amount": {
      "type": "integer",
      "description": "Amount of the gift card in cents"
    },
    "landing_page_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the gated landing page (also known as a gating URL). Recipients must visit this page before they can redeem the gift card, letting you gate redemption behind an action such as booking a demo or completing a form. Only valid for giftcards."
    },
    "share_uuid": {
      "type": "string"
    }
  }
}