HubSpot · Schema

TransactionalEmailResponse

Response after sending a transactional email

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string The status of the email send
statusId string A unique identifier for tracking the email status
sendResult string Additional details about the send result
requestedAt string When the send was requested
startedAt string When the send processing started
completedAt string When the send processing completed
View JSON Schema on GitHub

JSON Schema

marketing-emal-api-transactional-email-response-schema.json Raw ↑
{
  "$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-response-schema.json",
  "title": "TransactionalEmailResponse",
  "description": "Response after sending a transactional email",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "description": "The status of the email send",
      "example": "PENDING"
    },
    "statusId": {
      "type": "string",
      "description": "A unique identifier for tracking the email status",
      "example": "status-id-abc123"
    },
    "sendResult": {
      "type": "string",
      "description": "Additional details about the send result",
      "example": "SENT"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the send was requested",
      "example": "2025-03-15T14:30:00Z"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the send processing started",
      "example": "2025-03-15T14:30:00Z"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the send processing completed",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "status",
    "statusId"
  ]
}