HubSpot: Transactional email schemas

← Transactional email operations · All schemas

Create a SMTP API token — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
campaignName	string	Required within parent	A name for the campaign tied to the SMTP API token.
createContact	boolean	Required within parent	Indicates whether a contact should be created for email recipients.

Create a SMTP API token — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignName	string	Required within parent	A name for the campaign tied to the token.
createContact	boolean	Required within parent	Indicates whether a contact should be created for email recipients.
createdAt	string	Required within parent	Timestamp generated when a token is created. Format: date-time
createdBy	string	Required within parent	Email address of the user that sent the token creation request.
emailCampaignId	string	Required within parent	Identifier assigned to the campaign provided in the token creation request.
id	string	Required within parent	User name to log into the HubSpot SMTP server.
password	string	Optional	Password used to log into the HubSpot SMTP server.

Query SMTP API tokens by campaign name or an email Campaign Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging
results	array	Required within parent	An array of SMTP API token objects, each representing a token with its associated details.
results[]	Model	Each item	Expand Create a SMTP API token — response body

Referenced models: Create a SMTP API token — response body, Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging

Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging next

Referenced models: Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging next

Query SMTP API tokens by campaign name or an email Campaign Id — 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	A string token used to retrieve the next page of results. It indicates the position after the last item on the current page.
link	string	Optional	A string containing the URL link to the next page of results.

Send a single send transactional email asynchronously — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactProperties	object	Required within parent	The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment. Additional keys: see wildcard field
contactProperties.*	string	Additional keys
customProperties	object	Required within parent	The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}. Note: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property. Additional keys: see wildcard field
customProperties.*	object	Additional keys
emailId	integer	Required within parent	The content ID for the transactional email, which can be found in email tool UI. Format: int64
message	Model	Required within parent	Expand Send an email — request body — body message

Referenced models: Send an email — request body — body message