HubSpot: Listings schemas

← Listings operations · All schemas

Batch archive objects — listings batch Delete Listings — 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 property is required and is used to specify the objects involved in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of deals by ID — request body — body inputs item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Batch create objects — listings batch Create Listings — 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.
inputs[]	Model	Each item	Expand Batch create objects — listings batch Create Listings — request body — body inputs item

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

Batch create objects — listings batch Create Listings — 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 objects being created and other existing objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — listings create Listing — request body — body associations item
objectWriteTraceId	string	Optional	A unique identifier for tracing the creation request.
properties	object	Required within parent	Key-value pairs representing the properties of the object. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — listings create Listing — request body — body associations item

Batch read objects — listings batch Get Listings — 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 of the object to be read.
inputs[]	Model	Each item	Expand Archive a batch of deals by ID — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned in the response. Each string is a property name.
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. Each string is a property name.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Batch read objects — listings.batchGetListings — 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 that categorizes the type of error.
context	object	Required within parent	An object containing additional context about the error, where each key maps to 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 information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — 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 associated URIs that contain documentation or recommended remediation steps for the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message that describes the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object that may contain more specific details about the error's subcategory.

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

Batch read objects — listings.batchGetListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Listings 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 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 SimplePublicObject items that represent the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — listings merge — 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: Merge objects — listings merge — response body

Batch read objects — listings.batchGetListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Listings 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 Batch read objects — listings.batchGetListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs providing additional context 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 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 SimplePublicObject items that represent the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — listings merge — 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: Batch read objects — listings.batchGetListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — listings merge — response body

Create — listings create Listing — 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 define the relationships between the new object and other existing objects. Each association is represented by a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — listings create Listing — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are their corresponding values. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — listings create Listing — request body — body associations item

Create — listings create Listing — 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 Create — listings create Listing — request body — body associations item to
types	array	Required within parent	An array of association specifications that describe the types of relationships between the objects. Each specification includes details such as the category and type ID of the association.
types[]	Model	Each item	Expand Create meeting — request body — body associations item types item

Referenced models: Create meeting — request body — body associations item types item, Create — listings create Listing — request body — body associations item to

Create — listings create Listing — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier of the public object.

GDPR Delete — listings 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 ID of the object to be deleted.

List associations — listings 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 — listings get Listings — response body — paging
results	array	Required within parent	An array of objects, each representing an associated object with labels. Each object contains details about the association types and the ID of the associated object.
results[]	Model	Each item	Expand List associations — listings get Associations By To Object Type — response body — results item

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

List associations — listings 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 with labels, detailing the types and labels of associations for the object.
associationTypes[]	Model	Each item	Expand List associations — listings get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The ID of the object that is being associated.

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

List associations — listings 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, with possible values: HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The object type ID from which the association originates.
label	string	Optional	A human-readable label for the association.
toObjectTypeId	string	Optional	The object type ID to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	The identifier for the specific type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Referenced models: List — listings get Listings — response body — paging, Read — listings get Listing — response body

List — listings get Listings — 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 — listings get Listings — response body — paging next

Referenced models: List — listings get Listings — response body — paging next

List — listings get Listings — 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 serves as a cursor for fetching the next page of results. It is used to identify the position after the last item of the current page.
link	string	Optional	A URL string that provides a direct link to the next page of results. This link can be used to make a subsequent API call to retrieve additional data.

Merge objects — listings merge — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Input data for merging two records.
objectIdToMerge	string	Required within parent	The ID of the object that will be merged into the primary object.
primaryObjectId	string	Required within parent	The ID of the object that will remain after the merge.

Merge objects — listings merge — 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 unique identifier for tracing the request.
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 — listings get Listing — 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 of this object.
warnings	array	Optional	An array of warning objects related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

Referenced models: Create a contact — response body — warnings item, Read — listings get Listing — response body — properties With History value item

Read — listings get Listing — 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 collection of associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — listings get Listing — 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	An identifier for tracing the request related to the 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, including a history of changes over time. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — listings get Listing — 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	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

Referenced models: Create a contact — response body — warnings item, Read — listings get Listing — response body — associations value, Read — listings get Listing — response body — properties With History value item

Read — listings get Listing — 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 — listings search Listings — response body — paging
results	array	Required within parent	An array of associated IDs, each represented as an object with specific details about the association.
results[]	Model	Each item	Expand Read — listings get Listing — response body — associations value results item

Referenced models: Read — listings get Listing — response body — associations value results item, Search objects — listings search Listings — response body — paging

Read — listings get Listing — 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 that represents the ID of the object involved in the association.
type	string	Required within parent	The type of association between the objects. It is a string that specifies the nature or category of the association.

Read — listings get Listing — 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 derived. 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 derived. It is a string and is required.
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 — listings search Listings — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string used as a cursor for pagination to indicate where to start returning results.
filterGroups	array	Required within parent	An array of filter groups used to narrow down search results based on specific criteria.
filterGroups[]	Model	Each item	Expand Search objects — listings search Listings — 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 objects should be included in the response.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the objects.
sorts	array	Required within parent	An array of strings specifying the order in which the search results should be returned.
sorts[]	string	Each item

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

Search objects — listings search Listings — 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 that define the criteria for the filter group. Each filter specifies a property, an operator, and a value to be used in the filtering logic.
filters[]	Model	Each item	Expand Search objects — listings search Listings — request body — body filter Groups item filters item

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

Search objects — listings search Listings — 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	The upper boundary value for range filters. It is a string value.
operator	string	Required within parent	The operator used to compare the property value, such as 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', '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.
value	string	Optional	The specific value to filter for the property. It is a string value.
values	array	Optional	An array of string values used for filters that require multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search objects — listings search Listings — 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 — listings search Listings — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a public object in the collection.
results[]	Model	Each item	Expand Merge objects — listings merge — 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 — listings search Listings — response body — paging, Merge objects — listings merge — response body

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

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

Search objects — listings search Listings — 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 represents the cursor position before the current page.
link	string	Optional	A string URL that links to the previous page of results.

Update batch objects — listings batch Update Listings — 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 needed to update a specific CRM object.
inputs[]	Model	Each item	Expand Update batch objects — listings batch Update Listings — request body — body inputs item

Referenced models: Update batch objects — listings batch Update Listings — request body — body inputs item

Update batch objects — listings batch Update Listings — 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 operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and the value is the property's value. These properties define the attributes of the object being processed. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — listings update Listing — 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	A map of property names to their values, represented as strings. These properties will be updated on the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — listings batch Upsert Listings — 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 individual CRM object to be created or updated. This property is required.
inputs[]	Model	Each item	Expand Upsert batch objects — listings batch Upsert Listings — request body — body inputs item

Referenced models: Upsert batch objects — listings batch Upsert Listings — request body — body inputs item

Upsert batch objects — listings batch Upsert Listings — 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 for the object. This ID is used to determine whether to create a new object or update an existing one.
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 debugging or logging 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. These properties define the attributes of the object being upserted. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — listings.batchUpsertListings — 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 as a result of the upsert operation.
objectWriteTraceId	string	Optional	An identifier for tracing the creation or update request of the object.
properties	object	Required within parent	A map of property names to their values, representing the object's data. 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 — listings get Listing — 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 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 contact — response body — warnings item

Referenced models: Create a contact — response body — warnings item, Read — listings get Listing — response body — properties With History value item

Upsert batch objects — listings.batchUpsertListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Listings 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 SimplePublicUpsertObject items, representing the individual results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Upsert batch objects — listings.batchUpsertListings — 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 — listings.batchUpsertListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — listings.batchUpsertListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Listings 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 StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch read objects — listings.batchGetListings — 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 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 SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — listings.batchUpsertListings — 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: Batch read objects — listings.batchGetListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — listings.batchUpsertListings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item