HubSpot · JSON Structure

Marketing Emal Api Smtp Token Collection Response Structure

A paginated collection of SMTP tokens

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

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

Properties

results paging

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-collection-response-structure.json",
  "name": "SmtpTokenCollectionResponse",
  "description": "A paginated collection of SMTP tokens",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "The list of SMTP tokens",
      "items": {
        "type": "object",
        "description": "Represents an SMTP API token for transactional email sending",
        "required": [
          "id",
          "createdAt",
          "createdBy",
          "campaignName",
          "createContact"
        ],
        "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"
          }
        }
      },
      "example": [
        {
          "id": "smtp-token-abc123",
          "campaignName": "Password Reset Emails",
          "emailCampaignId": "campaign-xyz789",
          "createContact": true,
          "createdAt": "2024-01-15T10:30:00.000Z",
          "createdBy": "user@example.com"
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information",
      "properties": {
        "next": {
          "type": "object",
          "description": "Information about the next page",
          "required": [
            "after"
          ],
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor for the next page",
              "example": "c210cC10b2tlbi1hYmMxMjM%3D"
            },
            "link": {
              "type": "string",
              "description": "Link to the next page",
              "example": "https://app.hubspot.com/contacts/12345"
            }
          }
        }
      }
    }
  },
  "required": [
    "results"
  ]
}