HubSpot: Tickets schemas

← Tickets operations · All schemas

Batch archive objects — tickets batch Delete Tickets — 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 simple public object IDs. Each ID is represented by a SimplePublicObjectId object, which contains the unique identifier for a CRM object. This array is required for batch operations.
inputs[]	Model	Each item	Expand Read batch objects — tickets batch Get Tickets — request body — body inputs item

Referenced models: Read batch objects — tickets batch Get Tickets — request body — body inputs item

Batch create objects — tickets batch Create Tickets — 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 — tickets batch Create Tickets — request body — body inputs item

Referenced models: Batch create objects — tickets batch Create Tickets — request body — body inputs item

Batch create objects — tickets batch Create Tickets — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations for the objects being created. Each association is defined by a reference to the 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — tickets create Ticket — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for the objects being created.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM objects. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — tickets create Ticket — request body — body associations item

Create — tickets create Ticket — 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 — tickets create Ticket — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the property values. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — tickets create Ticket — request body — body associations item

Create — tickets create Ticket — 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 Read batch objects — carts batch Get Carts — request body — body inputs item
types	array	Required within parent	An array of association specifications that define the types of associations between the objects. Each item in the array is an AssociationSpec object.
types[]	Model	Each item	Expand Create meeting — request body — body associations item types item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item, Create meeting — request body — body associations item types item

Create — tickets create Ticket — 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 on this object.
properties	object	Required within parent	A map of property names to their current 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 — tickets get Ticket — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — tickets get Ticket — response body — properties With History value item

GDPR Delete — tickets 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 field and is used to specify the contact that should be permanently deleted.

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

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

List associations — tickets 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 and their labels between the objects.
associationTypes[]	Model	Each item	Expand List associations — tickets 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 — tickets get Associations By To Object Type — response body — results item association Types item

List associations — tickets 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 string identifier for the object type from which the association originates.
label	string	Optional	A string label that provides additional context or description for the association.
toObjectTypeId	string	Optional	The string identifier for the object type to which the association is directed.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	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 — tickets get Tickets — 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 — tickets get Tickets — 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 — tickets get Ticket — response body

Referenced models: List — tickets get Tickets — response body — paging, Read — tickets get Ticket — response body

List — tickets get Tickets — 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 — tickets get Tickets — response body — paging next

Referenced models: List — tickets get Tickets — response body — paging next

List — tickets get Tickets — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token that serves as a cursor for fetching the next page of results.
link	string	Optional	A string URL that provides a direct link to access the next page of results.

Merge objects — tickets merge Tickets — 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 of the object that will be merged into the primary object. This is a string.
primaryObjectId	string	Required within parent	The unique identifier of the primary object into which another object will be merged. This is a string.

Read batch objects — tickets batch Get Tickets — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing an object to be read by its ID.
inputs[]	Model	Each item	Expand Read batch objects — tickets batch Get Tickets — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned for each object. If a specified property is not present on an object, it will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. This may reduce the maximum number of objects that can be read in a single request.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — tickets batch Get Tickets — request body — body inputs item

Read batch objects — tickets batch Get Tickets — 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, represented as a string.

Read batch objects — tickets.batchGetTickets — 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 type of error.
context	object	Required within parent	An object containing additional context about the error, with each key mapping to an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects, each providing further information about specific aspects of 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 or recommended remediation steps for the error. 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 — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets 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 items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — tickets create Ticket — 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 status of the batch processing request. The expected value is "COMPLETE". Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create — tickets create Ticket — response body

Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — tickets.batchGetTickets — 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — tickets create Ticket — response body
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 — tickets create Ticket — response body, Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Read — tickets get Ticket — 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	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
associations	object	Optional	A map of associated object types to their associated IDs, representing the relationships this object has with others. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — tickets get Ticket — 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 trace ID for tracking 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. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — tickets get Ticket — 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 access 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 — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — tickets get Ticket — response body — associations value, Read — tickets get Ticket — response body — properties With History value item

Read — tickets get Ticket — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search objects — tickets search Tickets — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an AssociatedId object. This property is required.
results[]	Model	Each item	Expand Read — tickets get Ticket — response body — associations value results item

Referenced models: Read — tickets get Ticket — response body — associations value results item, Search objects — tickets search Tickets — response body — paging

Read — tickets get Ticket — response body — associations value results item

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

Read — tickets get Ticket — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The unique identifier of the source from which the value was obtained. It is a string.
sourceLabel	string	Optional	A label describing the source from which the value was obtained. It is a string.
sourceType	string	Required within parent	The type of source from which the value was obtained. It is a string.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value. It is an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value associated with the timestamp. It is a string.

Search objects — tickets search Tickets — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string used as a paging cursor token to retrieve the next set of results after a given object.
filterGroups	array	Required within parent	An array of filter groups, each containing a set of filters to apply to the search. Each filter group is combined using logical AND, while groups themselves are combined using logical OR.
filterGroups[]	Model	Each item	Expand Search objects — tickets search Tickets — 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 indicating which properties should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string used to perform a full-text search across searchable properties.
sorts	array	Required within parent	An array of strings specifying the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search objects — tickets search Tickets — request body — body filter Groups item

Search objects — tickets search Tickets — 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 to match against.
filters[]	Model	Each item	Expand Search objects — tickets search Tickets — request body — body filter Groups item filters item

Referenced models: Search objects — tickets search Tickets — request body — body filter Groups item filters item

Search objects — tickets search Tickets — 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 value used for range queries to specify the upper bound.
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 to filter by. It is a string value.
value	string	Optional	The specific value to compare against the property. It is a string value.
values	array	Optional	An array of string values used for 'IN' or 'NOT_IN' operations to specify multiple values to compare against.
values[]	string	Each item

Search objects — tickets search Tickets — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search objects — tickets search Tickets — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual object in the collection.
results[]	Model	Each item	Expand Create — tickets create Ticket — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — tickets search Tickets — response body — paging, Create — tickets create Ticket — response body

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

Referenced models: List — tickets get Tickets — response body — paging next, Search objects — tickets search Tickets — response body — paging prev

Search objects — tickets search Tickets — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to identify the starting point for retrieving the previous page of results.
link	string	Optional	A string containing the URL link to access the previous page of results.

Update batch objects — tickets batch Update Tickets — 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 representing a CRM object to be updated. Each item includes the object's properties and identifiers.
inputs[]	Model	Each item	Expand Update batch objects — tickets batch Update Tickets — request body — body inputs item

Referenced models: Update batch objects — tickets batch Update Tickets — request body — body inputs item

Update batch objects — tickets batch Update Tickets — 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 that serves as a trace identifier for write operations, useful for tracking and debugging purposes.
properties	object	Required within parent	A map of property names to their values, where each property is a string. This is used to define the attributes of the CRM objects in the batch. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — tickets update Ticket — 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 new value. All properties to be updated must be included here. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — tickets batch Upsert Tickets — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each containing the properties and unique identifiers needed to create or update a CRM object.
inputs[]	Model	Each item	Expand Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item

Referenced models: Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item

Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier for the CRM object.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object, useful for debugging or tracking changes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether this object was newly created (true) or updated (false) during the upsert operation.
objectWriteTraceId	string	Optional	A string used to trace the write operation that affected this object.
properties	object	Required within parent	A map of property names to their current values, with each value represented as 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 the timestamp of when it was set. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — tickets get Ticket — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — tickets get Ticket — response body — properties With History value item

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets 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 objects representing the results of the upsert operation. Each object is a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Upsert batch objects — tickets.batchUpsertTickets — 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 status of the batch processing request. The expected value is "COMPLETE". Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets 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 StandardError objects detailing any errors that occurred during the batch upsert operation.
errors[]	Model	Each item	Expand Read batch objects — tickets.batchGetTickets — 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 upsert 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 SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item