HubSpot: Partner clients schemas

← Partner clients operations · All schemas

Batch archive objects — partner Clients 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 string. This array is used to specify the IDs of the CRM objects involved in the batch operation.
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 Clients 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 its properties and associations. Each item in the array is a SimplePublicObjectBatchInputForCreate object.
inputs[]	Model	Each item	Expand Batch create objects — partner Clients batch Create — request body — body inputs item

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

Batch create objects — partner Clients 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 for the objects being created. Each association specifies a relationship between the new objects and existing objects in the CRM.
associations[]	Model	Each item	Expand Create — partner Clients create — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the objects. This can be used for tracking and debugging purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. This defines the attributes of the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

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

Batch create objects — partnerClients.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 indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies the error instance.
links	object	Required within parent	An object mapping link names to associated URIs, which may 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 representing the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

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

Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Create — partner Clients 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 Clients create — response body

Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 that describe any errors encountered during the batch operation.
errors[]	Model	Each item	Expand Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs for additional information related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items that represent the successful results of the batch operation.
results[]	Model	Each item	Expand Create — partner Clients 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 Clients create — response body, Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

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

Referenced models: Batch upsert objects — partner Clients batch Upsert — request body — body inputs item

Batch upsert objects — partner Clients 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 of the CRM object. This is required for identifying the object in upsert operations.
idProperty	string	Optional	A string representing the name of a property whose values are unique for this object type. This is used to identify the object uniquely by a property other than the default ID.
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object. This is optional and can be used for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property value. These properties define the attributes of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Batch upsert objects — partnerClients.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 the object is archived.
archivedAt	string	Optional	The date and time when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether the object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operations on 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 an array 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 Create — partner Clients create — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of the object.
warnings	array	Optional	An array of warnings related to the object, each represented by a PublicObjectWarning.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Batch upsert objects — partnerClients.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: Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 by a StandardError.
errors[]	Model	Each item	Expand Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors 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 by a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Batch upsert objects — partnerClients.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: Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — partner Clients 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 to be created between this object and other objects. Each association is defined by a PublicAssociationsForObject schema.
associations[]	Model	Each item	Expand Create — partner Clients create — request body — body associations item
properties	object	Required within parent	A map of property names to their values, representing the attributes of the CRM object to be created. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

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

Create — partner Clients 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 Archive a batch of contacts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects. Each item in the array is defined by the 'AssociationSpec' schema.
types[]	Model	Each item	Expand Create meeting — request body — body associations item types item

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

Create — partner Clients 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 representing the trace ID for write operations on 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 their historical values, where each value is an array of objects containing the value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Clients 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 containing 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 Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Create — partner Clients 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	A string representing the value associated with the timestamp.

GDPR Delete — partner Clients gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	An optional string property used to specify a unique property name, such as 'email', to identify the object. If the specified property value is not found, it will be added to a blocklist to prevent future use.
objectId	string	Required within parent	The unique identifier of the object to be deleted. This is a required string property.

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

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

List associations — partner Clients 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 with a label. Each item in the array defines the type of association and includes additional metadata.
associationTypes[]	Model	Each item	Expand List associations — partner Clients 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 Clients get Associations By To Object Type — response body — results item association Types item

List associations — partner Clients 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. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the object type ID of the source object in the association.
label	string	Optional	A string representing the label assigned to the association, providing a descriptive name for the relationship.
toObjectTypeId	string	Optional	A string representing 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 association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — partner Clients get Partner Clients — 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 Clients get Partner Clients — 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 Clients get Partner Client — response body

Referenced models: List — partner Clients get Partner Clients — response body — paging, Read — partner Clients get Partner Client — response body

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

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

List — partner Clients get Partner Clients — 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 indicate the position after the last item in the current page, allowing retrieval of the next set of results.
link	string	Optional	A string representing the URL link to the next page of results.

Read batch objects — partner Clients batch Get Partner Clients — 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	The name of a property whose values are unique for this object.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing an object to be read by its ID.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they 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 any specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

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

Read — partner Clients get Partner Client — 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 associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — partner Clients get Partner Client — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this CRM object.
objectWriteTraceId	string	Optional	A unique identifier for tracing the write operations on 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 historical values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Clients 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	A list of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — partner Clients get Partner Client — response body — associations value, Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Read — partner Clients get Partner Client — 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 Clients search Partner Clients — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object that includes the ID and type of the association.
results[]	Model	Each item	Expand Read — objects get Object — response body — associations value results item

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

Search — partner Clients search Partner Clients — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string token used for pagination to retrieve results after a specific point. This is typically used to fetch the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group contains multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search — partner Clients search Partner Clients — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. This helps control the size of the response. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against object properties.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property name followed by a direction (e.g., 'propertyName ASC' or 'propertyName DESC').
sorts[]	string	Each item

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

Search — partner Clients search Partner Clients — 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 conditions for the search query. Each filter defines a property, an operator, and a value to filter the objects by.
filters[]	Model	Each item	Expand Search — partner Clients search Partner Clients — request body — body filter Groups item filters item

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

Search — partner Clients search Partner Clients — 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 bound of a range when using range-based operators like 'BETWEEN'. It is a string and is used in conjunction with the 'value' property.
operator	string	Required within parent	The operator that defines how the filter is applied. It is a string and can be one of several predefined values such as 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', or '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 that identifies which property of the CRM object the filter will apply to.
value	string	Optional	The value to compare the property against. It is a string and is used with operators that require a single comparison value.
values	array	Optional	An array of strings representing multiple values to compare against the property. This is used with operators like 'IN' or 'NOT_IN' that require a list of potential matches.
values[]	string	Each item

Search — partner Clients search Partner Clients — 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 Clients search Partner Clients — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a simple public object returned in the response.
results[]	Model	Each item	Expand Create — partner Clients 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 Clients search Partner Clients — response body — paging, Create — partner Clients create — response body

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

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

Search — partner Clients search Partner Clients — 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 retrieve the previous page of results.
link	string	Optional	A URL string that provides a link to the previous page of results.

Update batch objects — partner Clients batch Update — request body — body

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

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

Update batch objects — partner Clients batch Update — request body — body inputs item

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

Update — partner Clients update Partner Client — 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 the name of a property and the value is the property's value. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys