HubSpot: Get revisions of a marketing email

← Marketing emails operations · Get started

Operation hubspot.marketing_emails_get_revisions

Provider route: GET /marketing/emails/2026-09/{emailId}/revisions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["marketingEmails"]["getRevisions"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.marketingEmails.getRevisions(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.marketing_emails.get_revisions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.emailId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.before	string	Optional
query.limit	integer	Optional	Format: int32

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get revisions of a marketing email — response body

Referenced models: Get revisions of a marketing email — response body

Schemas

9 more schemas are linked from the tables above, on the schema pages.

Get revisions of a marketing email — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Emails — response body — paging
results	array	Required within parent	An array of email version objects, each conforming to the VersionPublicEmail schema.
results[]	Model	Each item	Expand Get revisions of a marketing email — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of email version results available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Emails — response body — paging, Get revisions of a marketing email — response body — results item

List Emails — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Emails — response body — paging next
prev	Model	Optional	Expand List Emails — response body — paging prev

Referenced models: List Emails — response body — paging next, List Emails — response body — paging prev

Get revisions of a marketing email — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	ID of this marketing email version.
object	Model	Required within parent	Expand Create Email — response body
updatedAt	string	Required within parent	The date and time of the last update to the email, in ISO8601 representation. Format: date-time
user	Model	Required within parent	Expand Get a revision of a marketing email — response body — user

Referenced models: Get a revision of a marketing email — response body — user, Create Email — response body

List Emails — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
link	string	Optional	The link to the next page.

List Emails — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
link	string	Optional	The link to the previous page.

Get a revision of a marketing email — response body — user

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email address of the user.
fullName	string	Required within parent	First and last name of the user.
id	string	Required within parent	ID of the user.

Create Email — response body — stats

Field	Type	Presence	Description and constraints
$	object	Root
counters	object	Required within parent	Counters like number of `sent`, `open` or `delivered`. Additional keys: see wildcard field
counters.*	JSON	Additional keys
counters.* (anyOf 1)	integer	Alternative	Format: int64
counters.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deviceBreakdown	object	Required within parent	Statistics by device. Additional keys: see wildcard field
deviceBreakdown.*	object	Additional keys	Additional keys: see wildcard field
deviceBreakdown.*.*	JSON	Additional keys
deviceBreakdown.*.* (anyOf 1)	integer	Alternative	Format: int64
deviceBreakdown.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
qualifierStats	object	Required within parent	Number of emails that were dropped and bounced. Additional keys: see wildcard field
qualifierStats.*	object	Additional keys	Additional keys: see wildcard field
qualifierStats.*.*	JSON	Additional keys
qualifierStats.*.* (anyOf 1)	integer	Alternative	Format: int64
qualifierStats.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ratios	object	Required within parent	Ratios like `openratio` or `clickratio` Additional keys: see wildcard field
ratios.*	JSON	Additional keys
ratios.* (anyOf 1)	number	Alternative
ratios.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Email — response body — content

Field	Type	Presence	Description and constraints
$	object	Root
flexAreas	object	Optional	An object containing flexible area configurations, where each key is an area identifier and the value is an object with area properties. Additional keys: see wildcard field
flexAreas.*	object	Additional keys
plainTextVersion	string	Optional	A string containing the plain text version of the email content.
smartFields	object	Optional	An object containing smart field configurations, where each key is a field identifier and the value is a SmartEmailField object. Additional keys: see wildcard field
smartFields.*	Model	Additional keys	Expand List tags — response body
styleSettings	Model	Optional	Expand Create Email — response body — content style Settings
templatePath	string	Optional	A string representing the path to the email template used for this email.
themeSettingsValues	object	Optional	An object containing theme settings values, where each key is a setting identifier and the value is an object with setting properties. Additional keys: see wildcard field
themeSettingsValues.*	object	Additional keys
widgetContainers	object	Optional	An object containing widget container configurations, where each key is a container identifier and the value is an object with container properties. Additional keys: see wildcard field
widgetContainers.*	object	Additional keys
widgets	object	Optional	An object containing widget configurations, where each key is a widget identifier and the value is an object with widget properties. Additional keys: see wildcard field
widgets.*	object	Additional keys

Referenced models: List tags — response body, Create Email — response body — content style Settings

Create Email — response body — from

Field	Type	Presence	Description and constraints
$	object	Root
customReplyTo	string	Optional	The reply to recipients will see.
fromName	string	Optional	The name recipients will see.
replyTo	string	Optional	The from address and reply to email address (if no customReplyTo defined) recipients will see.

Create Email — response body — subscription Details

Field	Type	Presence	Description and constraints
$	object	Root
officeLocationId	string	Optional	ID of the selected office location.
preferencesGroupId	string	Optional	The identifier for the preferences group associated with the subscription. It is a string value.
subscriptionId	string	Optional	ID of the subscription.
subscriptionName	string	Optional	The name of the email subscription. It is a string value.

List tags — response body

Field	Type	Presence	Description and constraints
$	object	Root

Create Email — response body — to contact Ids

Field	Type	Presence	Description and constraints
$	object	Root
exclude	array	Optional	Excluded IDs.
exclude[]	string	Each item
include	array	Optional	Included IDs.
include[]	string	Each item

Policy, approvals and errors

SDK function policy ID: hubspot.marketing_emails_get_revisions. Catalog operation: marketing_emails_get_revisions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["content"]

Official provider source