HubSpot · Schema
TransactionalEmailRequest
Request body for sending a transactional email
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| emailId | integer | The ID of the transactional email template to use |
| message | object | The email message configuration |
| contactProperties | object | Properties to set on the contact (if createContact is enabled) |
| customProperties | object | Custom template variables for personalization |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/marketing-emal-api-transactional-email-request-schema.json",
"title": "TransactionalEmailRequest",
"description": "Request body for sending a transactional email",
"type": "object",
"properties": {
"emailId": {
"type": "integer",
"description": "The ID of the transactional email template to use",
"example": 12345678
},
"message": {
"type": "object",
"description": "The email message configuration",
"required": [
"to"
],
"properties": {
"to": {
"type": "string",
"format": "email",
"description": "The recipient's email address",
"example": "[email protected]"
},
"from": {
"type": "string",
"format": "email",
"description": "Override the from address (must be verified)",
"example": "[email protected]"
},
"sendId": {
"type": "string",
"description": "A unique ID to prevent duplicate sends",
"example": "unique-send-id-123"
},
"replyTo": {
"type": "array",
"description": "Reply-to email addresses",
"items": {
"type": "string",
"format": "email"
},
"example": [
"[email protected]"
]
},
"cc": {
"type": "array",
"description": "CC email addresses",
"items": {
"type": "string",
"format": "email"
},
"example": [
"[email protected]"
]
},
"bcc": {
"type": "array",
"description": "BCC email addresses",
"items": {
"type": "string",
"format": "email"
},
"example": [
"[email protected]"
]
}
}
},
"contactProperties": {
"type": "object",
"description": "Properties to set on the contact (if createContact is enabled)",
"additionalProperties": {
"type": "string"
},
"example": {
"firstname": "John",
"lastname": "Doe",
"company": "Acme Corp"
}
},
"customProperties": {
"type": "object",
"description": "Custom template variables for personalization",
"additionalProperties": {
"type": "string"
},
"example": {
"order_number": "ORD-12345",
"order_total": "$99.99"
}
}
},
"required": [
"emailId",
"message"
]
}