HubSpot: Objects schemas

← Objects operations · All schemas

Batch archive objects — objects batch Delete Objects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of a CRM object. This array is used to specify multiple objects for batch operations.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

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

Batch create objects — objects batch Create Objects — 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 represented by a SimplePublicObjectBatchInputForCreate object.
inputs[]	Model	Each item	Expand Batch create objects — objects batch Create Objects — request body — body inputs item

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

Batch create objects — objects batch Create Objects — 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 that define relationships between the CRM objects being created and other existing objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — objects create Object — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — objects create Object — request body — body associations item

Create — objects create Object — 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 the new CRM object to other existing objects. Each association specifies the related object and the type of relationship.
associations[]	Model	Each item	Expand Create — objects create Object — request body — body associations item
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. These properties define the characteristics of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — objects create Object — request body — body associations item

Create — objects create Object — 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. Each item in the array is a reference to the 'AssociationSpec' schema, which defines the category and type ID of the association.
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 — objects create Object — 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 used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their corresponding 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 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 — objects get Object — 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 Read — objects get Object — response body — warnings item

Referenced models: Read — objects get Object — response body — warnings item, Read — objects get Object — response body — properties With History value item

GDPR Delete — objects 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	An optional string property that specifies the unique property name used to identify the object. For example, setting this to 'email' allows the object to be identified by email address.
objectId	string	Required within parent	The unique identifier of the object to be deleted. This is a required field and must be a string.

List — objects get Objects — 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 — objects get Objects — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its properties and associated data.
results[]	Model	Each item	Expand Read — objects get Object — response body

Referenced models: List — objects get Objects — response body — paging, Read — objects get Object — response body

List — objects get Objects — 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 — objects get Objects — response body — paging next

Referenced models: List — objects get Objects — response body — paging next

List — objects get Objects — 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 as a cursor to fetch the next set of results.
link	string	Optional	A URL string that provides a direct link to the next page of results.

Read batch objects — objects batch Get Objects — 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	A string that specifies the name of a property whose values are unique for the object type, used to identify the objects.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of an object 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 indicating the properties for which historical values should be returned, along with the current values.
propertiesWithHistory[]	string	Each item

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

Read batch objects — objects.batchGetObjects — 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 categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, where each key is a context name and the value is an array 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 details about the error.
errors[]	Model	Each item	Expand Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
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 indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail. This is a string.
context	object	Optional	Context about the error condition, represented as an object with additional properties that are arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found. This is a string.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. This is a string.
subCategory	string	Optional	A specific category that contains more specific detail about the error. This is a string.

Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects 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 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 that are the result of the batch operation.
results[]	Model	Each item	Expand Create — objects create Object — 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 — objects create Object — response body

Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects 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 StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The 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 SimplePublicObject items that were processed in the batch operation.
results[]	Model	Each item	Expand Create — objects create Object — 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 — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — objects create Object — response body

Read — objects get Object — 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 respective associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — objects get Object — 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 CRM object.
objectWriteTraceId	string	Optional	An identifier used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values along with a history of changes, including timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — objects get Object — 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 link to access this object.
warnings	array	Optional	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — objects get Object — response body — warnings item

Referenced models: Read — objects get Object — response body — associations value, Read — objects get Object — response body — warnings item, Read — objects get Object — response body — properties With History value item

Read — objects get Object — 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 — objects search Objects — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an AssociatedId object.
results[]	Model	Each item	Expand Read — objects get Object — response body — associations value results item

Referenced models: Read — objects get Object — response body — associations value results item, Search objects — objects search Objects — response body — paging

Read — objects get Object — 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	The unique identifier for the associated object. It is a string.
type	string	Required within parent	The type of the association, represented as a string.

Read — objects get Object — 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 originated. This is a string.
sourceLabel	string	Optional	A label describing the source of the value. This is a string.
sourceType	string	Required within parent	The type of source from which the value originated. This 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 user ID of the person who last updated the value. This 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 associated with the timestamp. It is represented as a string.

Read — objects get Object — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context for the warning, with string values. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Search objects — objects search Objects — 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 to retrieve the next set of results.
filterGroups	array	Required within parent	An array of FilterGroup objects that specify the criteria for filtering the search results.
filterGroups[]	Model	Each item	Expand Search objects — objects search Objects — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied to the CRM objects.
sorts	array	Required within parent	An array of strings that define the sorting order of the search results.
sorts[]	string	Each item

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

Search objects — objects search Objects — 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 filter objects, each specifying a condition that objects must satisfy. Each filter includes properties such as the operator and propertyName to define the filtering logic.
filters[]	Model	Each item	Expand Search objects — objects search Objects — request body — body filter Groups item filters item

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

Search objects — objects search Objects — 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 high value used in range queries. It is a string.
operator	string	Required within parent	The operator used 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 to filter by. It is a string.
value	string	Optional	The value to compare against the property specified. It is a string.
values	array	Optional	An array of values used for operators that support multiple values such as 'IN'. Each item in the array is a string.
values[]	string	Each item

Search objects — objects search Objects — 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 — objects search Objects — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual object in the collection.
results[]	Model	Each item	Expand Create — objects create Object — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of simple public objects available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — objects search Objects — response body — paging, Create — objects create Object — response body

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

Referenced models: List — objects get Objects — response body — paging next, Search objects — objects search Objects — response body — paging prev

Search objects — objects search Objects — 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	A string token that indicates the position before the current page in the pagination sequence.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — objects batch Update Objects — 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 identifiers for a CRM object to be updated.
inputs[]	Model	Each item	Expand Update batch objects — objects batch Update Objects — request body — body inputs item

Referenced models: Update batch objects — objects batch Update Objects — request body — body inputs item

Update batch objects — objects batch Update Objects — 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	A string representing the unique identifier of the CRM object.
idProperty	string	Optional	A string representing the name of a property that holds unique values for this object type.
objectWriteTraceId	string	Optional	A string identifier used to trace the write operations for the object.
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 each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — objects update Object — 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 are expected to be strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — objects batch Upsert Objects — 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 representing an object to be created or updated. This is a required field.
inputs[]	Model	Each item	Expand Upsert batch objects — objects batch Upsert Objects — request body — body inputs item

Referenced models: Upsert batch objects — objects batch Upsert Objects — request body — body inputs item

Upsert batch objects — objects batch Upsert Objects — 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 object to be upserted.
idProperty	string	Optional	A string specifying the name of a property whose values are unique for this object type. This is used to identify objects uniquely.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values to be set on the CRM objects. Each property must be a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — objects.batchUpsertObjects — 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	An identifier for tracing the write operation of this object.
properties	object	Required within parent	A map of property names to their values for the object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including a history of previous values. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — objects get Object — 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 of the object.
warnings	array	Optional	An array of warnings associated with the object, detailing any issues or considerations.
warnings[]	Model	Each item	Expand Read — objects get Object — response body — warnings item

Referenced models: Read — objects get Object — response body — warnings item, Read — objects get Object — response body — properties With History value item

Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects 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, providing 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 objects representing the results of the batch upsert operation. Each object corresponds to a CRM object that was created or updated.
results[]	Model	Each item	Expand Upsert batch objects — objects.batchUpsertObjects — 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 — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects 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 specific issue and context.
errors[]	Model	Each item	Expand Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation 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 for each object in the batch.
results[]	Model	Each item	Expand Upsert batch objects — objects.batchUpsertObjects — 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 — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item