HubSpot: Discounts schemas

← Discounts operations · All schemas

Archive batch objects — discounts batch Delete Discounts — 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 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 Read batch objects — discounts batch Get Discounts — request body — body inputs item

Referenced models: Read batch objects — discounts batch Get Discounts — request body — body inputs item

Batch create objects — discounts batch Create Discounts — 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 single CRM object.
inputs[]	Model	Each item	Expand Batch create objects — discounts batch Create Discounts — request body — body inputs item

Referenced models: Batch create objects — discounts batch Create Discounts — request body — body inputs item

Batch create objects — discounts batch Create Discounts — 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 CRM objects, where each association specifies the related object IDs and types.
associations[]	Model	Each item	Expand Create — discounts create Discount — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM objects to be created. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — discounts create Discount — request body — body associations item

Batch upsert objects — discounts batch Upsert Discounts — 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 items, each representing an object to be upserted. This property is required.
inputs[]	Model	Each item	Expand Batch upsert objects — discounts batch Upsert Discounts — request body — body inputs item

Referenced models: Batch upsert objects — discounts batch Upsert Discounts — request body — body inputs item

Batch upsert objects — discounts batch Upsert Discounts — 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 for debugging or tracking purposes.
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 the value is the property value, both represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Batch upsert objects — discounts.batchUpsertDiscounts — 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 this object has been archived. A boolean value.
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	Indicates whether this object is newly created. A boolean value.
objectWriteTraceId	string	Optional	A trace identifier for the write operation that created or updated this object.
properties	object	Required within parent	A map of property names to their current values. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including historical data with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — discounts get Discount — 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.
warnings	array	Optional	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — discounts get Discount — response body — properties With History value item

Batch upsert objects — discounts.batchUpsertDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Discounts 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 objects that were created or updated as part of the batch operation.
results[]	Model	Each item	Expand Batch upsert objects — discounts.batchUpsertDiscounts — 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 — discounts.batchUpsertDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — discounts.batchUpsertDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Discounts 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 Read batch objects — discounts.batchGetDiscounts — 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 upsert operation. Each object contains details about the upserted object.
results[]	Model	Each item	Expand Batch upsert objects — discounts.batchUpsertDiscounts — 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: Read batch objects — discounts.batchGetDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Batch upsert objects — discounts.batchUpsertDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create — discounts create Discount — 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 this object and other objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — discounts create Discount — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object to be created. Each key is a property name, and each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — discounts create Discount — request body — body associations item

Create — discounts create Discount — 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 — leads create Lead — request body — body associations item to
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects.
types[]	Model	Each item	Expand Create — invoices create Invoice — request body — body associations item types item

Referenced models: Create — invoices create Invoice — request body — body associations item types item, Create — leads create Lead — request body — body associations item to

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

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

List associations — discounts 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 define the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — discounts 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 being made. It is a string.

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

List associations — discounts 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	A string representing the category of the association. 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 unique identifier of the object type from which the association originates.
label	string	Optional	A string that provides an optional label for the association, allowing for user-defined descriptions.
toObjectTypeId	string	Optional	A string representing the unique identifier of the object type to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer that uniquely identifies the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — discounts get Discounts — 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 — discounts get Discounts — 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 — discounts get Discount — response body

Referenced models: List — discounts get Discounts — response body — paging, Read — discounts get Discount — response body

List — discounts get Discounts — 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 — discounts get Discounts — response body — paging next

Referenced models: List — discounts get Discounts — response body — paging next

List — discounts get Discounts — 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 fetch the next page of results.
link	string	Optional	A string containing the URL link to the next page of results.

Merge objects — discounts merge — request body — body

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

Merge objects — discounts merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this CRM object, represented as a string.
objectWriteTraceId	string	Optional	A string used for tracing the 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 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 Read — discounts get Discount — 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 Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — discounts get Discount — response body — properties With History value item

Read batch objects — discounts batch Get Discounts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of the object to be read.
inputs[]	Model	Each item	Expand Read batch objects — discounts batch Get Discounts — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned in the response for each object.
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.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — discounts batch Get Discounts — request body — body inputs item

Read batch objects — discounts batch Get Discounts — request body — body inputs item

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 CRM object. It is a string that is required for operations involving specific objects.

Read batch objects — discounts.batchGetDiscounts — 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 condition, 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 representing the unique identifier for this error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

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

Read batch objects — discounts.batchGetDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Discounts Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Merge objects — discounts merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Merge objects — discounts merge — response body

Read batch objects — discounts.batchGetDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Discounts 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 standard errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — discounts.batchGetDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Merge objects — discounts merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — discounts.batchGetDiscounts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — discounts merge — response body

Read — discounts get Discount — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their respective associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — discounts get Discount — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	An identifier for tracing the 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 along with a history of changes, including timestamps and sources. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — discounts get Discount — 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.
warnings	array	Optional	A list of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

Referenced models: Create a company — response body — warnings item, Read — discounts get Discount — response body — associations value, Read — discounts get Discount — response body — properties With History value item

Read — discounts get Discount — 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 — discounts search Discounts — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an AssociatedId object.
results[]	Model	Each item	Expand Read — products get Product — response body — associations value results item

Referenced models: Read — products get Product — response body — associations value results item, Search — discounts search Discounts — response body — paging

Read — discounts get Discount — 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 representing the unique identifier of the source from which the value was obtained.
sourceLabel	string	Optional	A string providing a human-readable label for the source of the value.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated. This property is required.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	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 value associated with the timestamp. This is a string representing the data that was recorded.

Search — discounts search Discounts — 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. It represents the last successfully read resource and is used to fetch the next set of results in a paged response.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group can contain multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search — discounts search Discounts — 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 result set. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be returned in the search results. If a specified property is not present on the objects, it will be ignored.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the objects' properties.
sorts	array	Required within parent	An array of strings specifying the sort order of the search results. Each string represents a property to sort by, with optional direction (e.g., 'propertyName ASC' or 'propertyName DESC').
sorts[]	string	Each item

Referenced models: Search — discounts search Discounts — request body — body filter Groups item

Search — discounts search Discounts — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of Filter objects that define the criteria for the search. Each filter specifies a property, an operator, and a value or range of values to filter by.
filters[]	Model	Each item	Expand Search — discounts search Discounts — request body — body filter Groups item filters item

Referenced models: Search — discounts search Discounts — request body — body filter Groups item filters item

Search — discounts search Discounts — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string representing the upper boundary value for range-based filters. It is used with operators like 'BETWEEN' to specify a range.
operator	string	Required within parent	The operator used to compare the property value. 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 applies to.
value	string	Optional	The value to compare the property against. This is a string used in conjunction with the operator to determine if the property meets the filter condition.
values	array	Optional	An array of strings representing multiple values for the filter. This is used with operators like 'IN' or 'NOT_IN' to match any of the specified values.
values[]	string	Each item

Search — discounts search Discounts — 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 — discounts search Discounts — 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 Merge objects — discounts merge — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search — discounts search Discounts — response body — paging, Merge objects — discounts merge — response body

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

Referenced models: List — discounts get Discounts — response body — paging next, Search — discounts search Discounts — response body — paging prev

Search — discounts search Discounts — 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 link to access the previous page of results.

Update batch objects — discounts batch Update Discounts — 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 CRM object to be updated.
inputs[]	Model	Each item	Expand Update batch objects — discounts batch Update Discounts — request body — body inputs item

Referenced models: Update batch objects — discounts batch Update Discounts — request body — body inputs item

Update batch objects — discounts batch Update Discounts — 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	An optional string used to trace the write operations on the objects.
properties	object	Required within parent	A map of property names to their values for the objects being processed. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — discounts update Discount — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	A map of property names to their values, where each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys