HubSpot: Partner services schemas

← Partner services operations · All schemas

Archive batch — partner Services batch Archive — 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 to be processed. This property is required.
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 — partner Services batch Create — 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 — partner Services batch Create — request body — body inputs item

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

Batch create objects — partner Services batch Create — 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 objects. Each association is represented by a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — partner Services create — 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 to be created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — partner Services create — request body — body associations item

Batch create objects — partnerServices.batchCreate — 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 detail about the error category.

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

Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner 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 information 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 Create — partner Services create — 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 — partner Services create — response body

Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner 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 Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
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 — partner Services create — 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 — partner Services create — response body, Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

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

Referenced models: Create — partner Services create — request body — body associations item

Create — partner Services create — 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 — partner Services create — request body — body associations item to
types	array	Required within parent	An array of association specifications that define the types of relationships between the objects. Each item in the array is an AssociationSpec object.
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 — partner Services create — request body — body associations item to

Create — partner Services create — 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	A string representing the unique identifier of the public object.

Create — partner Services create — 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 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, where each value includes a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Services create — 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, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Create — partner Services create — response body — warnings item

Referenced models: Create — partner Services create — response body — warnings item, Create — partner Services create — response body — properties With History value item

Create — partner Services create — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string identifier for the specific source of the value.
sourceLabel	string	Optional	A string label providing additional context about the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
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	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The recorded value as a string.

Create — partner Services create — 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 about the warning, where each key is a string and each value is a string. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

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

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

List associations — partner 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 label. These specify the types of associations that exist between the objects.
associationTypes[]	Model	Each item	Expand List associations — partner Services get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which associations are made. It is a string.

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

List associations — partner 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, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The object type ID of the source object in the association.
label	string	Optional	A string label for the association, providing a human-readable name or description.
toObjectTypeId	string	Optional	The object type ID of the target object in the association.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

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

Referenced models: List — partner Services get Partner Services — response body — paging next

List — partner Services get Partner 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 used as a cursor to retrieve the next set of results in a paginated response.
link	string	Optional	A string containing the URL link to the next page of results.

Read batch objects — partner Services batch Get Partner 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 containing an ID used to identify the objects to be read in the batch operation.
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 specific properties to be returned for each object in the batch.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings indicating the properties for which the history of previous values should be returned. Using this may reduce the maximum number of objects that can be read in a single request.
propertiesWithHistory[]	string	Each item

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

Read — partner Services get Partner 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 collections of associated IDs, representing the relationships this object has with other objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — partner Services get Partner 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	A trace identifier for the write operation that last modified 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, including a history of changes, represented as arrays of values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Services create — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create — partner Services create — response body — warnings item

Referenced models: Read — partner Services get Partner Service — response body — associations value, Create — partner Services create — response body — warnings item, Create — partner Services create — response body — properties With History value item

Read — partner Services get Partner 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 — partner Services search Partner Services — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by the 'AssociatedId' schema. This property is required.
results[]	Model	Each item	Expand Read — calls get Call — response body — associations value results item

Referenced models: Read — calls get Call — response body — associations value results item, Search — partner Services search Partner Services — response body — paging

Search — partner Services search Partner Services — 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 paging cursor token to retrieve results after a specific point in the result set.
filterGroups	array	Required within parent	An array of filter groups used to refine the search results. Each filter group contains multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search — partner Services search Partner Services — 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 the properties to be returned 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 fields and order by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — partner Services search Partner Services — request body — body filter Groups item

Search — partner Services search Partner 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 define the individual filtering criteria within the group. Each filter specifies a property, an operator, and a value or range of values to filter by.
filters[]	Model	Each item	Expand Search — partner Services search Partner Services — request body — body filter Groups item filters item

Referenced models: Search — partner Services search Partner Services — request body — body filter Groups item filters item

Search — partner Services search Partner 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 upper bound value for range-based filter operations. It is a string.
operator	string	Required within parent	The operator that defines the type of comparison to be made. 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 which the filter is applied. It is a string.
value	string	Optional	The value to be used in the filter operation. It is a string.
values	array	Optional	An array of values used for filter operations that require multiple inputs, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — partner Services search Partner 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 — partner Services search Partner 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 — partner Services create — 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 — partner Services search Partner Services — response body — paging, Create — partner Services create — response body

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

Referenced models: List — partner Services get Partner Services — response body — paging next, Search — partner Services search Partner Services — response body — paging prev

Search — partner Services search Partner 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 that indicates the cursor position before the current page, used to fetch the previous set of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — partner Services batch Update Partner 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 representing a CRM object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update batch objects — partner Services batch Update Partner Services — request body — body inputs item

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

Update batch objects — partner Services batch Update Partner 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 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. This is used to define the attributes of each CRM object in the batch. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — partner Services update Partner 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 keys are property names and values are the new values to be set for those properties. Each property value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — partner Services batch Upsert — 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 object contains the data necessary for creating or updating a CRM object in a batch operation.
inputs[]	Model	Each item	Expand Upsert batch objects — partner Services batch Upsert — request body — body inputs item

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

Upsert batch objects — partner Services batch Upsert — 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 being upserted.
idProperty	string	Optional	The name of a property whose values are unique for this object
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 object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — partnerServices.batchUpsert — 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 has been 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 was newly created during the upsert operation.
objectWriteTraceId	string	Optional	A string used to trace the write operation that created or updated this object.
properties	object	Required within parent	A map of property names to their current values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each with a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Services create — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create — partner Services create — response body — warnings item

Referenced models: Create — partner Services create — response body — warnings item, Create — partner Services create — response body — properties With History value item

Upsert batch objects — partnerServices.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner 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, providing additional information 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 conforming to the SimplePublicUpsertObject schema.
results[]	Model	Each item	Expand Upsert batch objects — partnerServices.batchUpsert — 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 — partnerServices.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — partnerServices.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner 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 error provides details about what went wrong.
errors[]	Model	Each item	Expand Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, which may provide additional information about the 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. Each object corresponds to a successfully processed item.
results[]	Model	Each item	Expand Upsert batch objects — partnerServices.batchUpsert — 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 — partnerServices.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item