HubSpot · JSON Structure

Hubspot Marketing Emal Transactional Email Request Structure

Request body for sending a transactional email

Type: object Properties: 4 Required: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

TransactionalEmailRequest is a JSON Structure definition published by HubSpot, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

emailId message contactProperties customProperties

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "Request body for sending a transactional email",
  "name": "TransactionalEmailRequest",
  "properties": {
    "emailId": {
      "type": "integer",
      "description": "The ID of the transactional email template to use"
    },
    "message": {
      "type": "object",
      "description": "The email message configuration",
      "properties": {
        "to": {
          "type": "email",
          "description": "The recipient's email address"
        },
        "from": {
          "type": "email",
          "description": "Override the from address (must be verified)"
        },
        "sendId": {
          "type": "string",
          "description": "A unique ID to prevent duplicate sends"
        },
        "replyTo": {
          "type": "array",
          "description": "Reply-to email addresses",
          "items": {
            "type": "email"
          }
        },
        "cc": {
          "type": "array",
          "description": "CC email addresses",
          "items": {
            "type": "email"
          }
        },
        "bcc": {
          "type": "array",
          "description": "BCC email addresses",
          "items": {
            "type": "email"
          }
        }
      },
      "required": [
        "to"
      ]
    },
    "contactProperties": {
      "type": "object",
      "description": "Properties to set on the contact (if createContact is enabled)"
    },
    "customProperties": {
      "type": "object",
      "description": "Custom template variables for personalization"
    }
  },
  "required": [
    "emailId",
    "message"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}