HubSpot: Courses schemas

← Courses operations · All schemas

Archive batch objects — courses batch Delete Courses — 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 object in the array contains the ID of a CRM object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of deals by ID — request body — body inputs item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Batch create objects — courses batch Create Courses — 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 necessary to create a single CRM object.
inputs[]	Model	Each item	Expand Batch create objects — courses batch Create Courses — request body — body inputs item

Referenced models: Batch create objects — courses batch Create Courses — request body — body inputs item

Batch create objects — courses batch Create Courses — 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 to be created for the objects. Each association specifies the relationship between objects, using the PublicAssociationsForObject schema.
associations[]	Model	Each item	Expand Create — courses create Course — request body — body associations item
objectWriteTraceId	string	Optional	A unique identifier for tracing the creation request.
properties	object	Required within parent	Key-value pairs representing the properties of the object. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — courses create Course — request body — body associations item

Batch upsert objects — courses batch Upsert Courses — 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 representing a single CRM object to be upserted. Each object must conform to the SimplePublicObjectBatchInputUpsert schema.
inputs[]	Model	Each item	Expand Batch upsert objects — courses batch Upsert Courses — request body — body inputs item

Referenced models: Batch upsert objects — courses batch Upsert Courses — request body — body inputs item

Batch upsert objects — courses batch Upsert Courses — 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 identifier used for tracing the write operation of the object.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values. These properties define the attributes of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Batch upsert objects — courses.batchUpsertCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object has been archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	An identifier used for tracing the creation or update request of the object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each containing a value and its associated timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — courses get Course — 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 of this object, represented as a string.
warnings	array	Optional	An array 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 — courses get Course — response body — properties With History value item

Batch upsert objects — courses.batchUpsertCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Courses 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 that provide additional information about 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 individual results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Batch upsert objects — courses.batchUpsertCourses — 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 — courses.batchUpsertCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — courses.batchUpsertCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Courses 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, each detailing an error encountered during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or resources 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 SimplePublicUpsertObject items, each representing the result of an individual upsert operation within the batch.
results[]	Model	Each item	Expand Batch upsert objects — courses.batchUpsertCourses — 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 — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Batch upsert objects — courses.batchUpsertCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create — courses create Course — 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 for the object, where each association specifies the related object and the types of associations. Each item in the array is a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — courses create Course — request body — body associations item
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, both represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — courses create Course — request body — body associations item

Create — courses create Course — 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 — courses create Course — request body — body associations item to
types	array	Required within parent	An array of association specifications, each defining the category and type of association between the objects.
types[]	Model	Each item	Expand Create — courses create Course — request body — body associations item types item

Referenced models: Create — courses create Course — request body — body associations item types item, Create — courses create Course — request body — body associations item to

Create — courses create Course — 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 object.

Create — courses create Course — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	The category of the association, indicating its origin or definition. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the unique identifier for the type of association. Format: int32

Create — courses create Course — 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	An identifier used for tracing the creation or update request of the object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each containing a value and a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — courses get Course — 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 Create a company — response body — warnings item

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

GDPR Delete — courses 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 of the object to be deleted.

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

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

List associations — courses 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 and type information. This defines the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — courses get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The ID of the object to which the associations are made.

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

List associations — courses 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, which can be HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED. 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 human-readable name for 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	The unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Referenced models: List — courses get Courses — response body — paging, Read — courses get Course — response body

List — courses get Courses — 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 — courses get Courses — response body — paging next

Referenced models: List — courses get Courses — response body — paging next

List — courses get Courses — 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 URL string that provides a direct link to the next page of results.

Read batch objects — courses batch Get Courses — 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 ID to be included in the batch read operation.
inputs[]	Model	Each item	Expand Archive a batch of deals by ID — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of deals by ID — request body — body inputs item

Read batch objects — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string that categorizes the error.
context	object	Required within parent	An object containing additional context about the error, with each property being 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 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 — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Courses 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — courses create Course — 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 — courses create Course — response body

Read batch objects — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Courses 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 — courses.batchGetCourses — 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 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Create — courses create Course — 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 — courses.batchGetCourses — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — courses create Course — response body

Read — courses get Course — 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 associated IDs, each represented by a CollectionResponseAssociatedId object. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — courses get Course — 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, represented as a string.
objectWriteTraceId	string	Optional	An identifier used for tracing the write operations on the 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 their historical values, each represented by a ValueWithTimestamp object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — courses get Course — 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 represented by a PublicObjectWarning object.
warnings[]	Model	Each item	Expand Create a company — response body — warnings item

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

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

Referenced models: Read — courses get Course — response body — associations value results item, Search — courses search Courses — response body — paging

Read — courses get Course — 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 string representing the unique identifier for the association.
type	string	Required within parent	A string indicating the type of association, which categorizes the relationship between objects.

Read — courses get Course — 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 was obtained. 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. It is a string representing the data captured at a specific point in time.

Search — courses search Courses — 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 for pagination. It is used to retrieve the next set of results after the current page.
filterGroups	array	Required within parent	An array of filter groups used to define the search criteria. Each filter group contains filters that determine which CRM objects are included in the search results.
filterGroups[]	Model	Each item	Expand Search — courses search Courses — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return per page. This property controls the pagination of the search results. Format: int32
properties	array	Required within parent	An array of strings specifying the properties of the CRM objects 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 filter the CRM objects. This is an optional field that can be used to perform a text-based search.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property by which the results should be sorted.
sorts[]	string	Each item

Referenced models: Search — courses search Courses — request body — body filter Groups item

Search — courses search Courses — 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 to filter by.
filters[]	Model	Each item	Expand Search — courses search Courses — request body — body filter Groups item filters item

Referenced models: Search — courses search Courses — request body — body filter Groups item filters item

Search — courses search Courses — 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 in range queries to specify the upper bound.
operator	string	Required within parent	The operator used to compare the property and 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 on. This is a string value.
value	string	Optional	The value to compare against the property specified. This is a string value.
values	array	Optional	An array of string values used for filters that require multiple values, such as 'IN' or 'NOT_IN' operators.
values[]	string	Each item

Search — courses search Courses — 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 — courses search Courses — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Create — courses create Course — 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 — courses search Courses — response body — paging, Create — courses create Course — response body

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

Referenced models: List — courses get Courses — response body — paging next, Search — courses search Courses — response body — paging prev

Search — courses search Courses — 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 the previous page of results.

Update batch objects — courses batch Update Courses — 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 object contains the properties and identifiers needed to update a CRM object.
inputs[]	Model	Each item	Expand Update batch objects — courses batch Update Courses — request body — body inputs item

Referenced models: Update batch objects — courses batch Update Courses — request body — body inputs item

Update batch objects — courses batch Update Courses — request body — body inputs item

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

Update — courses update Course — 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 a string. This object contains the properties of the CRM object that need to be updated. Additional keys: see wildcard field
properties.*	string	Additional keys