Transactional Templates: Template

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sendgrid/main/json-schema/sendgrid-transactional-template-schema.json",
  "title": "Transactional Templates: Template",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendgrid-templates-api-openapi.yml#/components/schemas/TransactionalTemplate",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the transactional template.",
      "minLength": 36,
      "maxLength": 36,
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "description": "The name for the transactional template.",
      "maxLength": 100
    },
    "generation": {
      "type": "string",
      "description": "Defines the generation of the template.",
      "$ref": "#/$defs/Generation1"
    },
    "updated_at": {
      "type": "string",
      "description": "The date and time that this transactional template version was updated.",
      "pattern": "^(\\d{4}-\\d{2}-\\d{2}) ((\\d{2}):(\\d{2}):(\\d{2}))$"
    },
    "versions": {
      "type": "array",
      "description": "The different versions of this transactional template.",
      "items": {
        "$ref": "#/$defs/TransactionalTemplatesVersionOutputLean"
      }
    },
    "warning": {
      "$ref": "#/$defs/TransactionalTemplateWarning"
    }
  },
  "required": [
    "generation",
    "id",
    "name",
    "updated_at"
  ],
  "$defs": {
    "Active1": {
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "Editor1": {
      "type": "string",
      "enum": [
        "code",
        "design"
      ]
    },
    "Generation1": {
      "type": "string",
      "enum": [
        "legacy",
        "dynamic"
      ]
    },
    "TransactionalTemplateWarning": {
      "title": "Warning",
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Warning message for the user"
        }
      }
    },
    "TransactionalTemplatesVersionOutputLean": {
      "title": "Transactional Templates: Version Output Lean",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the transactional template version.",
          "format": "uuid"
        },
        "template_id": {
          "type": "string",
          "description": "ID of the transactional template."
        },
        "active": {
          "type": "integer",
          "description": "Set the version as the active version associated with the template. Only one version of a template can be active. The first version created for a template will automatically be set to Active.",
          "$ref": "#/$defs/Active1"
        },
        "name": {
          "type": "string",
          "description": "Name of the transactional template version.",
          "maxLength": 100
        },
        "subject": {
          "type": "string",
          "description": "Subject of the new transactional template version.",
          "maxLength": 255
        },
        "updated_at": {
          "type": "string",
          "description": "The date and time that this transactional template version was updated."
        },
        "generate_plain_content": {
          "type": "boolean",
          "description": "If true, plain_content is always generated from html_content. If false, plain_content is not altered.",
          "default": true
        },
        "html_content": {
          "type": "string",
          "description": "The HTML content of the Design."
        },
        "plain_content": {
          "type": "string",
          "description": "Plain text content of the Design."
        },
        "editor": {
          "type": "string",
          "description": "The editor used in the UI.",
          "$ref": "#/$defs/Editor1"
        },
        "thumbnail_url": {
          "type": "string",
          "description": "A Thumbnail preview of the template's html content."
        }
      }
    }
  }
}