HubSpot: Services schemas

← Services operations · All schemas

Batch archive objects — services batch Delete Services — 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 representing the ID of a CRM object to be processed. This property is required.
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 — services batch Create Services — 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, each conforming to the SimplePublicObjectBatchInputForCreate schema, representing the CRM objects to be created in the batch. Each object includes properties and associations necessary for creation.
inputs[]	Model	Each item	Expand Batch create objects — services batch Create Services — request body — body inputs item

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

Batch create objects — services batch Create Services — 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 for the objects being created. Each association is defined by a PublicAssociationsForObject object.
associations[]	Model	Each item	Expand Create — services create Service — request body — body associations item
objectWriteTraceId	string	Optional	An 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 — services create Service — request body — body associations item

Create — services create Service — 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 objects that define associations between the CRM object being created and other existing objects. Each association specifies the related object and the type of association.
associations[]	Model	Each item	Expand Create — services create Service — 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 attributes of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — services create Service — request body — body associations item

Create — services create Service — 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 deals by ID — request body — body inputs item
types	array	Required within parent	An array of association specifications, each defining the type of association between the objects. Each item in the array follows the AssociationSpec schema.
types[]	Model	Each item	Expand Create — services create Service — request body — body associations item types item

Referenced models: Archive a batch of deals by ID — request body — body inputs item, Create — services create Service — request body — body associations item types item

Create — services create Service — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	A string that specifies the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer that uniquely identifies the type of association. Format: int32

Create — services create Service — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the 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	An identifier used to trace the creation or update request of the object.
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 arrays of historical values, each including a timestamp and the value at that time. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — services get Service — 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 warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — services get Service — response body — properties With History value item

List associations — services 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 — services get Services — response body — paging
results	array	Required within parent	An array of objects, each containing multiple associations with labels. These objects are of type MultiAssociatedObjectWithLabel.
results[]	Model	Each item	Expand List associations — services get Associations By To Object Type — response body — results item

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

List associations — services 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 category, type ID, and optional label. These define the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — services get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The ID of the object to which this object is associated.

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

List associations — services 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 string identifier for the object type from which the association originates.
label	string	Optional	A human-readable label for the association.
toObjectTypeId	string	Optional	The string identifier for the object type to which the association is directed.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	The unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Referenced models: List — services get Services — response body — paging, Read — services get Service — response body

List — services get Services — 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 — services get Services — response body — paging next

Referenced models: List — services get Services — response body — paging next

List — services get Services — 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 item on the current page, used to retrieve the next set of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Merge objects — services merge Services — 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 as the primary object after the merge.

Read batch objects — services batch Get Services — 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 representing the ID of an 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 specifying the properties to be returned for each object. If a specified property is not present on an object, it will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. If a specified property is not present on an object, it will be ignored.
propertiesWithHistory[]	string	Each item

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

Read batch objects — services.batchGetServices — 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 error.
context	object	Required within parent	An object containing additional context about the error, with each key mapping 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 about the error or recommended remediation steps. 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: Batch insert events — response body — errors item errors item

Read batch objects — services.batchGetServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Services 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 or documentation 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 — services create Service — 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 — services create Service — response body

Read batch objects — services.batchGetServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Services 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 — services.batchGetServices — 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — services create Service — 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 — services create Service — response body, Read batch objects — services.batchGetServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Read — services get Service — 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 corresponding collection of associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — services get Service — 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 creation or update request of the object.
properties	object	Required within parent	A map of property names to their current values. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — services get Service — 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 Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — services get Service — response body — associations value, Read — services get Service — response body — properties With History value item

Read — services get Service — 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 — services search Services — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an AssociatedId object. This property is required and contains the list of associations.
results[]	Model	Each item	Expand Read — services get Service — response body — associations value results item

Referenced models: Read — services get Service — response body — associations value results item, Search objects — services search Services — response body — paging

Read — services get Service — 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 string representing the unique identifier of the associated object.
type	string	Required within parent	A string indicating the type of association between the objects.

Read — services get Service — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The unique identifier of the source from which the value originated. 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 originated. 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 actual value associated with the timestamp. It is a string.

Search objects — services search Services — 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 use for fetching the next set of results.
filterGroups	array	Required within parent	An array of filter groups to apply to the search. Each filter group contains a set of filters that are combined using a logical AND operation.
filterGroups[]	Model	Each item	Expand Search objects — services search Services — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying 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 search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against object properties.
sorts	array	Required within parent	An array of strings specifying the sorting criteria for the search results. Each string represents a property to sort by, optionally prefixed with a '-' to indicate descending order.
sorts[]	string	Each item

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

Search objects — services search Services — 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 specify the criteria for the search. Each filter defines a condition that must be met for an object to be included in the search results.
filters[]	Model	Each item	Expand Search objects — services search Services — request body — body filter Groups item filters item

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

Search objects — services search Services — 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 representing the upper boundary value for range-based filters.
operator	string	Required within parent	The operator used for comparison in the filter. 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 on. It is a string representing the specific field of the object.
value	string	Optional	The value to compare against the property. It is a string that specifies the target value for the filter operation.
values	array	Optional	An array of strings representing multiple values to be used in filters that support multiple comparisons, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search objects — services search Services — 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 — services search Services — 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 — services create Service — 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 — services search Services — response body — paging, Create — services create Service — response body

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

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

Search objects — services search Services — 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 used to identify the position of the previous 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 — services batch Update Services — 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 for updating a specific CRM object.
inputs[]	Model	Each item	Expand Update batch objects — services batch Update Services — request body — body inputs item

Referenced models: Update batch objects — services batch Update Services — request body — body inputs item

Update batch objects — services batch Update Services — 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 write operations for the objects in the batch.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM objects. Each key is a property name and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — services update Service — 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 value. The properties are used to define or update the attributes of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — services batch Upsert Services — 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 for a single object to be created or updated.
inputs[]	Model	Each item	Expand Upsert batch objects — services batch Upsert Services — request body — body inputs item

Referenced models: Upsert batch objects — services batch Upsert Services — request body — body inputs item

Upsert batch objects — services batch Upsert Services — 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 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 operations 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 each value is the corresponding property value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — services.batchUpsertServices — 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 creation or update request.
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 their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — services get Service — 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 Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — services get Service — response body — properties With History value item

Upsert batch objects — services.batchUpsertServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Services 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 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 — services.batchUpsertServices — 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 — services.batchUpsertServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — services.batchUpsertServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Services 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 represented as a StandardError.
errors[]	Model	Each item	Expand Read batch objects — services.batchGetServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information about 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 results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Upsert batch objects — services.batchUpsertServices — 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 — services.batchUpsertServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Read batch objects — services.batchGetServices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item