HubSpot: Emails schemas

← Emails operations · All schemas

Batch create objects — emails batch Create Emails — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of objects to be created, each defined by the SimplePublicObjectBatchInputForCreate schema. This property is required and allows for the specification of multiple objects in a single request.
inputs[]	Model	Each item	Expand Batch create objects — emails batch Create Emails — request body — body inputs item

Referenced models: Batch create objects — emails batch Create Emails — request body — body inputs item

Batch create objects — emails batch Create Emails — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations to be created for each object. Each association links the object to another object type and specifies the relationship between them.
associations[]	Model	Each item	Expand Create — emails create Email — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object. This can be useful for debugging and tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the corresponding property value. This defines the properties of the CRM objects to be created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — emails create Email — request body — body associations item

Create — emails create Email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link this object to other objects. Each association is defined by a 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — emails create Email — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — emails create Email — request body — body associations item

Create — emails create Email — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Archive a batch of contacts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects.
types[]	Model	Each item	Expand Create a contact — request body — body associations item types item

Referenced models: Archive a batch of contacts — request body — body inputs item, Create a contact — request body — body associations item types item

Create — emails create Email — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for object write operations.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, where each value is an array of objects containing a timestamp and value. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — emails get Email — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — emails get Email — response body — properties With History value item

GDPR Delete — emails gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectId	string	Required within parent	The unique identifier of the object to be deleted. It is a required string property.

List associations — emails get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
paging	Model	Optional	Expand List — emails get Emails — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object includes details about the associated object and the types of associations.
results[]	Model	Each item	Expand List associations — emails get Associations By To Object Type — response body — results item

Referenced models: List — emails get Emails — response body — paging, List associations — emails get Associations By To Object Type — response body — results item

List associations — emails get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications, each including a label. This defines the types of associations and their labels between the objects.
associationTypes[]	Model	Each item	Expand List associations — emails get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object that is being associated. It is a string value.

Referenced models: List associations — emails get Associations By To Object Type — response body — results item association Types item

List associations — emails get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	The category of the association, which can be one of 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the type ID of the object from which the association originates.
label	string	Optional	A string label that describes the association.
toObjectTypeId	string	Optional	A string representing the type ID of the object to which the association is directed.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — emails get Emails — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand List — emails get Emails — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations items, each representing a CRM object with its associated data.
results[]	Model	Each item	Expand Read — emails get Email — response body

Referenced models: List — emails get Emails — response body — paging, Read — emails get Email — response body

List — emails get Emails — 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 — emails get Emails — response body — paging next

Referenced models: List — emails get Emails — response body — paging next

List — emails get 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	A string token that indicates the position after the last successfully read resource, used for fetching the next page of results.
link	string	Optional	A URL string that provides a direct link to the next page of results.

Read batch objects — emails batch Get Emails — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID used to identify the objects to be read.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned in the response for each object.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings representing the properties to be returned along with their history of previous values for each object.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of contacts — request body — body inputs item

Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies the error instance.
links	object	Required within parent	An object mapping link names to URIs that provide documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string representing the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Emails Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — emails create Email — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create — emails create Email — response body

Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Emails Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors that occurred during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors that occurred during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each represented as a SimplePublicObject.
results[]	Model	Each item	Expand Create — emails create Email — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — emails create Email — response body

Read — emails get Email — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their associated IDs, each represented as a collection of associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — emails get Email — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their current values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, each represented as an array of values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — emails get Email — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — emails get Email — response body — associations value, Read — emails get Email — response body — properties With History value item

Read — emails get Email — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search objects — emails search Emails — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an 'AssociatedId' object. This property is required.
results[]	Model	Each item	Expand Read — emails get Email — response body — associations value results item

Referenced models: Read — emails get Email — response body — associations value results item, Search objects — emails search Emails — response body — paging

Read — emails get Email — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	A unique identifier for the associated object, represented as a string.
type	string	Required within parent	The type of association, represented as a string.

Read — emails get Email — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The identifier of the source from which the value was obtained. It is a string.
sourceLabel	string	Optional	A label describing the source of the value. It is a string.
sourceType	string	Required within parent	The type of source from which the value was obtained. It is a string.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value. It is an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value of the property at the given timestamp. It is a string.

Search objects — emails search Emails — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token for retrieving the next set of results. This is used for pagination in search results.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for filtering the search results. Each filter group contains multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search objects — emails search Emails — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. This helps to control the size of the result set. Format: int32
properties	array	Required within parent	An array of strings specifying the properties of the CRM objects to be returned in the search results. If a specified property is not present on the objects, it will be ignored.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects. This is used to perform a text-based search.
sorts	array	Required within parent	An array of strings indicating the sorting order of the search results. Each string specifies a property to sort by, optionally prefixed with a '-' to indicate descending order.
sorts[]	string	Each item

Referenced models: Search objects — emails search Emails — request body — body filter Groups item

Search objects — emails search Emails — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filters that define the criteria for the search. Each filter specifies a condition that must be met, and the array allows for multiple conditions to be combined.
filters[]	Model	Each item	Expand Search objects — emails search Emails — request body — body filter Groups item filters item

Referenced models: Search objects — emails search Emails — request body — body filter Groups item filters item

Search objects — emails search Emails — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string value used in range-based filter operations to specify the upper bound.
operator	string	Required within parent	The operator used in the filter to compare the property value. It is a string and valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property on which the filter is applied. It is a string that identifies the specific field of the object.
value	string	Optional	The value to be used in the filter operation. It is a string that represents the specific criteria for the filter.
values	array	Optional	An array of strings representing multiple values to be used in the filter operation, typically for 'IN' or 'NOT_IN' operators.
values[]	string	Each item

Search objects — emails search Emails — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search objects — emails search Emails — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a CRM object.
results[]	Model	Each item	Expand Create — emails create Email — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — emails search Emails — response body — paging, Create — emails create Email — response body

Search objects — emails search 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 get Emails — response body — paging next
prev	Model	Optional	Expand Search — projects search Projects — response body — paging prev

Referenced models: List — emails get Emails — response body — paging next, Search — projects search Projects — response body — paging prev

Update batch objects — emails batch Update Emails — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each containing the properties and optional associations for a CRM object. This array is used to specify the objects to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update batch objects — emails batch Update Emails — request body — body inputs item

Referenced models: Update batch objects — emails batch Update Emails — request body — body inputs item

Update batch objects — emails batch Update Emails — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	The id to be updated. This can be the object id, or the unique property value of the idProperty property
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operations for the objects. This can be useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. This is used to define the properties of the CRM objects in the batch. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — emails update Email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's new value. All properties must be strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — emails batch Upsert Emails — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each containing the data necessary to create or update a CRM object. This is a required field.
inputs[]	Model	Each item	Expand Upsert batch objects — emails batch Upsert Emails — request body — body inputs item

Referenced models: Upsert batch objects — emails batch Upsert Emails — request body — body inputs item

Upsert batch objects — emails batch Upsert Emails — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the CRM object.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operations for this object.
properties	object	Required within parent	A map of property names to their values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — emails get Email — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — emails get Email — response body — properties With History value item

Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Emails Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs that provide additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Emails Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each detailing the issue and context.
errors[]	Model	Each item	Expand Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs for additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of objects representing the results of the upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — emails.batchGetEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — emails.batchUpsertEmails — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item