HubSpot: Quotes schemas

← Quotes operations · All schemas

Archive a batch of quotes by ID — 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 a unique identifier for a CRM object. This property is required and is used to specify the objects involved in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

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

Create a batch of quotes — 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 SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations needed to create a new CRM object.
inputs[]	Model	Each item	Expand Create a batch of quotes — request body — body inputs item

Referenced models: Create a batch of quotes — request body — body inputs item

Create a batch of quotes — 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 the relationship between the new object and existing objects in the CRM.
associations[]	Model	Each item	Expand Create — quotes create Quote — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes. This is optional and can be used to track the creation process.
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 objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — quotes create Quote — request body — body associations item

Create a batch of quotes — 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 specifying the category of the error.
context	object	Required within parent	An object containing additional context about the error condition, 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 representing a more specific category or subcategory of the error.

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

Create a batch of quotes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Quotes Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject instances representing the results of the batch operation.
results[]	Model	Each item	Expand Create — quotes create Quote — 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 — quotes create Quote — response body

Create a batch of quotes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Quotes 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 Create a batch of quotes — 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 number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items that represent the results of the batch operation.
results[]	Model	Each item	Expand Create — quotes create Quote — 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 — quotes create Quote — response body, Create a batch of quotes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create or update a batch of quotes by unique property values — 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 objects, each containing the data for a CRM object to be created or updated. Each object must include properties and may include an objectWriteTraceId, id, and idProperty.
inputs[]	Model	Each item	Expand Create or update a batch of quotes by unique property values — request body — body inputs item

Referenced models: Create or update a batch of quotes by unique property values — request body — body inputs item

Create or update a batch of quotes by unique property values — 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.
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 of the object.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Create or update a batch of quotes by unique property values — 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	Indicates whether the CRM object is archived. A boolean value.
archivedAt	string	Optional	The date and time when the CRM object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the CRM object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the CRM object.
new	boolean	Required within parent	Indicates whether the CRM object is newly created. A boolean value.
objectWriteTraceId	string	Optional	An identifier used to trace the write operation for the CRM object.
properties	object	Required within parent	A map of property names to their values for the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including the history of previous values, for the CRM object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — quotes get Quote — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the CRM object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL link to the CRM object.
warnings	array	Optional	An array of warnings related to the CRM object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — quotes get Quote — response body — warnings item

Referenced models: Read — quotes get Quote — response body — warnings item, Read — quotes get Quote — response body — properties With History value item

Create or update a batch of quotes by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Quotes 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 batch upsert operation.
results[]	Model	Each item	Expand Create or update a batch of quotes by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation was 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 or update a batch of quotes by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of quotes by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Quotes 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 detailed information about the issue.
errors[]	Model	Each item	Expand Create a batch of quotes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of objects representing the results of the batch upsert operation. Each object contains details about the upserted objects.
results[]	Model	Each item	Expand Create or update a batch of quotes by unique property values — 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: Create or update a batch of quotes by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Create a batch of quotes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — quotes create Quote — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link this object to other objects. Each association is defined by a 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — quotes create Quote — 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 corresponding property values for the CRM object. Each property value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — quotes create Quote — request body — body associations item

Create — quotes create Quote — 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 — quotes create Quote — 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 specifies the association category and type ID.
types[]	Model	Each item	Expand Create — calls create Call — request body — body associations item types item

Referenced models: Create — calls create Call — request body — body associations item types item, Create — quotes create Quote — request body — body associations item to

Create — quotes create Quote — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for the public object. It is a string that is required for identifying objects within the CRM system.

Create — quotes create Quote — 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 for tracing the write operations related to 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 values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — quotes get Quote — 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 associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — quotes get Quote — response body — warnings item

Referenced models: Read — quotes get Quote — response body — warnings item, Read — quotes get Quote — response body — properties With History value item

GDPR Delete — quotes gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectId	string	Required within parent	The unique identifier for the object to be deleted. This is a required string property.

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

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

List associations — quotes get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications with labels, detailing the types of associations and their corresponding labels. Each item in the array is an AssociationSpecWithLabel object.
associationTypes[]	Model	Each item	Expand List associations — quotes get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object to which associations are made. It is a string.

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

List associations — quotes 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 that can be used to describe or identify the association.
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 — quotes get Quotes — 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 — quotes get Quotes — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its associated data.
results[]	Model	Each item	Expand Read — quotes get Quote — response body

Referenced models: List — quotes get Quotes — response body — paging, Read — quotes get Quote — response body

List — quotes get Quotes — 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 — quotes get Quotes — response body — paging next

Referenced models: List — quotes get Quotes — response body — paging next

List — quotes get Quotes — 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 to identify the starting point for the next page of results.
link	string	Optional	A URL string that provides a direct link to access the next page of results.

Read a batch of quotes by internal ID, or unique property values — 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 objects, each containing an 'id' field, representing the CRM objects to be read.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of property names to be returned in the response. Each element is a string representing a property name.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of property names for which the history of previous values should be returned. Each element is a string representing a property name.
propertiesWithHistory[]	string	Each item

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

Read — quotes get Quote — 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 IDs, representing the associations of this object with other CRM objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — quotes get Quote — 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 string identifier used 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 changes, represented as arrays of values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — quotes get Quote — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL link to this object in HubSpot.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — quotes get Quote — response body — warnings item

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

Read — quotes get Quote — 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 for quotes using specified criteria — response body — paging
results	array	Required within parent	An array of associated IDs, where each item is an object containing an 'id' and 'type'.
results[]	Model	Each item	Expand Read — quotes get Quote — response body — associations value results item

Referenced models: Read — quotes get Quote — response body — associations value results item, Search for quotes using specified criteria — response body — paging

Read — quotes get Quote — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the association. It is a string.
type	string	Required within parent	The type of the association. It is a string.

Read — quotes get Quote — 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 that provided the value.
sourceLabel	string	Optional	A string label that describes the source of the value.
sourceType	string	Required within parent	A string specifying the type of source from which the value was obtained.
timestamp	string	Required within parent	A date-time string indicating when the value was recorded. 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 of the property at the specified timestamp.

Read — quotes get Quote — response body — warnings item

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

Search for quotes using specified criteria — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for the search. Each filter group contains a set of filters that are combined using logical AND.
filterGroups[]	Model	Each item	Expand Search for quotes using specified criteria — 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 the properties to be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied across the specified properties.
sorts	array	Required within parent	An array of strings indicating the fields and order by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search for quotes using specified criteria — request body — body filter Groups item

Search for quotes using specified criteria — 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 conditions for the search. Each filter specifies a property, an operator, and a value or range of values to match against.
filters[]	Model	Each item	Expand Search for quotes using specified criteria — request body — body filter Groups item filters item

Referenced models: Search for quotes using specified criteria — request body — body filter Groups item filters item

Search for quotes using specified criteria — 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 value used for range comparisons in the filter. It is a string.
operator	string	Required within parent	The operator used to compare the property with the value(s). Valid operators 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 on which the filter is applied. It is a string.
value	string	Optional	The value used for comparison in the filter. It is a string.
values	array	Optional	An array of values used for comparison in the filter. Each value is a string.
values[]	string	Each item

Search for quotes using specified criteria — 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 for quotes using specified criteria — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual CRM object.
results[]	Model	Each item	Expand Create — quotes create Quote — 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 for quotes using specified criteria — response body — paging, Create — quotes create Quote — response body

Search for quotes using specified criteria — 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 — quotes get Quotes — response body — paging next
prev	Model	Optional	Expand Search for quotes using specified criteria — response body — paging prev

Referenced models: Search for quotes using specified criteria — response body — paging prev, List — quotes get Quotes — response body — paging next

Search for quotes using specified criteria — 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 representing the cursor token used to access the previous page of results.
link	string	Optional	A string containing the URL link to the previous page of results.

Update a batch of quotes by internal ID, or unique property values — 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 items, each containing the properties and optional associations for a single object. This is used to specify the data for each object in the batch operation.
inputs[]	Model	Each item	Expand Update a batch of quotes by internal ID, or unique property values — request body — body inputs item

Referenced models: Update a batch of quotes by internal ID, or unique property values — request body — body inputs item

Update a batch of quotes by internal ID, or unique property values — 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 operations for 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 the key is the property name and the value is the property value. This is used to define the properties of the CRM objects. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — quotes update Quote — 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. All properties must be strings. Additional keys: see wildcard field
properties.*	string	Additional keys