HubSpot: Email templates schemas

← Email templates operations · All schemas

Create — email Templates create Email Template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Required within parent	The main content of the email template. This is a required field and must be a string.
folderId	string	Optional	The identifier of the folder in which the template is stored. This is an optional field and must be a string if provided.
name	string	Required within parent	The name of the email template. This is a required field and must be a string.
subject	string	Optional	The subject line of the email template. This is an optional field and must be a string if provided.

List folders — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List folders — response body — paging
results	array	Required within parent	An array of PublicFolder objects, each representing a folder containing email templates.
results[]	Model	Each item	Expand List folders — response body — results item

Referenced models: List folders — response body — paging, List folders — response body — results item

List folders — 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 List folders — response body — paging next

Referenced models: List folders — response body — paging next

List folders — 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 that serves as the paging cursor token, indicating the position after the last successfully read resource.
link	string	Optional	A string representing the URL link to the next page of results.

List folders — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	JSON	Optional
createdAt (anyOf 1)	integer	Alternative	The timestamp indicating when the folder was created, represented as an integer in int64 format. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	The unique identifier for the folder, represented as a string.
name	string	Optional	The name of the folder, represented as a string.
updatedAt	JSON	Optional
updatedAt (anyOf 1)	integer	Alternative	The timestamp indicating when the folder was last updated, represented as an integer in int64 format. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List folders — response body — paging
results	array	Required within parent	An array of public templates. Each item in the array is an object representing a template with properties such as id, name, subject, body, folderId, ownerId, createdAt, and updatedAt.
results[]	Model	Each item	Expand Update template — response body

Referenced models: List folders — response body — paging, Update template — response body

Update template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
body	object	Required within parent	An object representing the body content of the email template.
folderId	object	Required within parent	An object representing the identifier of the folder where the email template is stored.
name	object	Required within parent	An object representing the name of the email template.
subject	object	Required within parent	An object representing the subject line of the email template.

Update template — response body

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Optional	The content of the email template, represented as a string.
createdAt	JSON	Optional
createdAt (anyOf 1)	integer	Alternative	The timestamp indicating when the email template was created, represented as an integer in int64 format. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
folderId	string	Optional	The identifier of the folder where the email template is stored, represented as a string.
id	string	Required within parent	The unique identifier for the email template, represented as a string.
name	string	Optional	The name of the email template, represented as a string.
ownerId	string	Optional	The identifier of the owner of the email template, represented as a string.
subject	string	Optional	The subject line of the email template, represented as a string.
updatedAt	JSON	Optional
updatedAt (anyOf 1)	integer	Alternative	The timestamp indicating when the email template was last updated, represented as an integer in int64 format. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$