HubSpot · JSON Structure

Marketing Emal Api Smtp Token Structure

Represents an SMTP API token for transactional email sending

Type: object Properties: 6 Required: 5
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

SmtpToken is a JSON Structure definition published by HubSpot, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id campaignName emailCampaignId createContact createdAt createdBy

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/marketing-emal-api-smtp-token-structure.json",
  "name": "SmtpToken",
  "description": "Represents an SMTP API token for transactional email sending",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the SMTP token",
      "example": "smtp-token-abc123"
    },
    "campaignName": {
      "type": "string",
      "description": "The name of the email campaign associated with this token",
      "example": "Password Reset Emails"
    },
    "emailCampaignId": {
      "type": "string",
      "description": "The ID of the associated email campaign",
      "example": "campaign-xyz789"
    },
    "createContact": {
      "type": "boolean",
      "description": "Whether sending an email creates a contact if one doesn't exist",
      "example": true
    },
    "createdAt": {
      "type": "datetime",
      "description": "When the token was created",
      "example": "2024-01-15T10:30:00.000Z"
    },
    "createdBy": {
      "type": "string",
      "description": "The user or application that created the token",
      "example": "user@example.com"
    }
  },
  "required": [
    "id",
    "createdAt",
    "createdBy",
    "campaignName",
    "createContact"
  ]
}