HubSpot: Postal mail schemas

← Postal mail operations · All schemas

Batch archive objects — postal Mail batch Delete Postal Mail — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of a CRM object. This array is used to specify multiple objects for batch processing.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

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

Batch create objects — postal Mail batch Create Postal Mail — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of objects, each containing the properties and associations necessary to create a simple public object. Each item in the array is of type SimplePublicObjectBatchInputForCreate.
inputs[]	Model	Each item	Expand Batch create objects — postal Mail batch Create Postal Mail — request body — body inputs item

Referenced models: Batch create objects — postal Mail batch Create Postal Mail — request body — body inputs item

Batch create objects — postal Mail batch Create Postal Mail — 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 objects defining the associations between the CRM objects being created and other existing objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — postal Mail create Postal Mail — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used to trace the write operations for the objects being created. This is optional and can be used for tracking purposes.
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 being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — postal Mail create Postal Mail — request body — body associations item

Batch upsert objects — postal Mail batch Upsert Postal Mail — 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 details for an individual upsert operation.
inputs[]	Model	Each item	Expand Batch upsert objects — postal Mail batch Upsert Postal Mail — request body — body inputs item

Referenced models: Batch upsert objects — postal Mail batch Upsert Postal Mail — request body — body inputs item

Batch upsert objects — postal Mail batch Upsert Postal Mail — 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. This is required for identifying the object to be upserted.
idProperty	string	Optional	A string specifying the name of a property that uniquely identifies the object type. This is used when the object is identified by a unique property other than the default ID.
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object. This is optional and can be used for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the corresponding value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether the object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operations for 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 timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL associated with the object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — warnings item

Referenced models: Merge objects — postal Mail merge — response body — warnings item, Merge objects — postal Mail merge — response body — properties With History value item

Batch upsert objects — postalMail.batchUpsertPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Postal Mail 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 results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Batch upsert objects — postalMail.batchUpsertPostalMail — 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 — postalMail.batchUpsertPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — postalMail.batchUpsertPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Postal Mail 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 operation.
errors[]	Model	Each item	Expand Read batch objects — postalMail.batchGetPostalMail — 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 SimplePublicUpsertObject items representing the objects that were successfully upserted in the batch operation.
results[]	Model	Each item	Expand Batch upsert objects — postalMail.batchUpsertPostalMail — 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 — postalMail.batchUpsertPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Read batch objects — postalMail.batchGetPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — postal Mail create Postal Mail — 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 objects that define associations between the new CRM object and other existing objects. Each association specifies the target object and the types of associations.
associations[]	Model	Each item	Expand Create — postal Mail create Postal Mail — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — postal Mail create Postal Mail — request body — body associations item

Create — postal Mail create Postal Mail — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Archive a batch of contacts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects. Each item in the array is a reference to the 'AssociationSpec' schema.
types[]	Model	Each item	Expand Create — calls create Call — request body — body associations item types item

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

GDPR Delete — postal Mail 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	A string representing the name of a property used to uniquely identify the object, such as 'email'. This property is optional.
objectId	string	Required within parent	A string representing the unique identifier of the object to be deleted. This property is required.

List Associations — postal Mail 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 — postal Mail get Postal Mail — response body — paging
results	array	Required within parent	An array of objects, each representing an associated object with its labels. Each item in the array is a MultiAssociatedObjectWithLabel.
results[]	Model	Each item	Expand List Associations — postal Mail get Associations By To Object Type — response body — results item

Referenced models: List — postal Mail get Postal Mail — response body — paging, List Associations — postal Mail get Associations By To Object Type — response body — results item

List Associations — postal Mail 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, that defines the types of associations between this object and the target object. Each item in the array is an AssociationSpecWithLabel object.
associationTypes[]	Model	Each item	Expand List Associations — postal Mail get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which this object is associated. It is a string.

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

List Associations — postal Mail 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	A string representing the type ID of the object from which the association originates.
label	string	Optional	A string representing the label of the association, providing a human-readable name or description.
toObjectTypeId	string	Optional	A string representing the type ID of the object to which the association is directed.
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 — postal Mail get Postal Mail — 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 — postal Mail get Postal Mail — 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 — postal Mail get Postal Mail Objectid — response body

Referenced models: List — postal Mail get Postal Mail — response body — paging, Read — postal Mail get Postal Mail Objectid — response body

List — postal Mail get Postal Mail — 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 — postal Mail get Postal Mail — response body — paging next

Referenced models: List — postal Mail get Postal Mail — response body — paging next

List — postal Mail get Postal Mail — 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 representing the cursor position for fetching the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Merge objects — postal Mail merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the 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 to trace the creation or update request of the CRM 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 their historical values, each entry containing a value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — postal Mail merge — 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 the object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — warnings item

Referenced models: Merge objects — postal Mail merge — response body — warnings item, Merge objects — postal Mail merge — response body — properties With History value item

Merge objects — postal Mail merge — 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 label providing additional context or description of the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was obtained.
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, represented as an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The actual value being tracked, represented as a string.

Merge objects — postal Mail merge — response body — warnings item

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

Read batch objects — postal Mail batch Get Postal Mail — 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	A string representing the name of a property whose values are unique for this object type.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of a CRM object to be read.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings representing 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 representing the properties to be returned along with their history of previous values. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
propertiesWithHistory[]	string	Each item

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

Read batch objects — postalMail.batchGetPostalMail — 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 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 individual errors.
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 provide 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 that provides more specific categorization of the error.

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

Read batch objects — postalMail.batchGetPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Postal Mail 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 that represent the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — postal Mail 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 — postal Mail merge — response body

Read batch objects — postalMail.batchGetPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Postal Mail 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 errors that occurred during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Read batch objects — postalMail.batchGetPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
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
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 results from the batch operation, each represented as a SimplePublicObject.
results[]	Model	Each item	Expand Merge objects — postal Mail 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 — postal Mail merge — response body, Read batch objects — postalMail.batchGetPostalMail — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Read — postal Mail get Postal Mail Objectid — 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. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — postal Mail get Postal Mail Objectid — 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 used for tracing the write operations on this object.
properties	object	Required within parent	A map of the object's property names to their current values. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of the object's property names to their values, including historical data with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — postal Mail merge — 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 associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — postal Mail merge — response body — warnings item

Referenced models: Read — postal Mail get Postal Mail Objectid — response body — associations value, Merge objects — postal Mail merge — response body — warnings item, Merge objects — postal Mail merge — response body — properties With History value item

Read — postal Mail get Postal Mail Objectid — 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 — postal Mail search Postal Mail — 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 — postal Mail get Postal Mail Objectid — response body — associations value results item

Referenced models: Read — postal Mail get Postal Mail Objectid — response body — associations value results item, Search — postal Mail search Postal Mail — response body — paging

Read — postal Mail get Postal Mail Objectid — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the association. It is a string that distinguishes this association from others.
type	string	Required within parent	The type of association, represented as a string. This indicates the nature or category of the relationship between the associated objects.

Search — postal Mail search Postal Mail — 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 results after a specific point.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for filtering CRM objects.
filterGroups[]	Model	Each item	Expand Search — postal Mail search Postal Mail — request body — body filter Groups item
limit	integer	Required within parent	An integer defining the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be matched against CRM object properties.
sorts	array	Required within parent	An array of strings indicating the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — postal Mail search Postal Mail — request body — body filter Groups item

Search — postal Mail search Postal Mail — 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, each defining a condition to be applied in the search. Each filter includes properties such as 'operator' and 'propertyName' to specify the filtering logic.
filters[]	Model	Each item	Expand Search — postal Mail search Postal Mail — request body — body filter Groups item filters item

Referenced models: Search — postal Mail search Postal Mail — request body — body filter Groups item filters item

Search — postal Mail search Postal Mail — 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 bound of a range when using range-based operators like BETWEEN.
operator	string	Required within parent	The operator used to compare the property with the specified value(s). It is a string and 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. It is a string that identifies which property of the CRM object is being evaluated.
value	string	Optional	The value to compare against the specified property. This is a string and is 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 to compare against the property. This is used with operators that support multiple values, such as IN or NOT_IN.
values[]	string	Each item

Search — postal Mail search Postal Mail — 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 — postal Mail search Postal Mail — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a CRM object with basic properties.
results[]	Model	Each item	Expand Merge objects — postal Mail 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 — postal Mail search Postal Mail — response body — paging, Merge objects — postal Mail merge — response body

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

Referenced models: List — postal Mail get Postal Mail — response body — paging next, Search — postal Mail search Postal Mail — response body — paging prev

Search — postal Mail search Postal Mail — 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 position before the current page in the pagination sequence.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — postal Mail batch Update Postal Mail Objecttype — 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 necessary for updating a specific CRM object.
inputs[]	Model	Each item	Expand Update batch objects — postal Mail batch Update Postal Mail Objecttype — request body — body inputs item

Referenced models: Update batch objects — postal Mail batch Update Postal Mail Objecttype — request body — body inputs item

Update batch objects — postal Mail batch Update Postal Mail Objecttype — request body — body inputs item

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