HubSpot: Communications schemas

← Communications operations · All schemas

Batch archive objects — communications batch Delete Communications — 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 string. This array specifies the IDs of the CRM objects to be processed in the batch operation.
inputs[]	Model	Each item	Expand Batch read objects — communications batch Get Communications — request body — body inputs item

Referenced models: Batch read objects — communications batch Get Communications — request body — body inputs item

Batch create objects — communications batch Create Communications — 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 to be created, each defined by the SimplePublicObjectBatchInputForCreate schema.
inputs[]	Model	Each item	Expand Batch create objects — communications batch Create Communications — request body — body inputs item

Referenced models: Batch create objects — communications batch Create Communications — request body — body inputs item

Batch create objects — communications batch Create Communications — 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 that define relationships between the objects being created and other existing objects. Each association is represented by a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — communications create Communication — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the objects.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM objects. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — communications create Communication — request body — body associations item

Batch read objects — communications batch Get Communications — request body — body

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

Referenced models: Batch read objects — communications batch Get Communications — request body — body inputs item

Batch read objects — communications batch Get Communications — 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 object. It is a string that is required to perform operations on the object within the CRM.

Batch read objects — communications.batchGetCommunications — 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 categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with properties 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 detailed information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that provide documentation or 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

Batch read objects — communications.batchGetCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Communications 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 context or navigation 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 Merge objects — communications 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 — communications merge — response body

Batch read objects — communications.batchGetCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Communications 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 instances detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch read objects — communications.batchGetCommunications — 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 total 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 instances representing the objects that were successfully processed in the batch operation.
results[]	Model	Each item	Expand Merge objects — communications 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: Batch read objects — communications.batchGetCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — communications merge — response body

Create — communications create Communication — 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 the new CRM object to other objects. Each association specifies the related object and the type of relationship.
associations[]	Model	Each item	Expand Create — communications create Communication — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. These properties define the characteristics of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — communications create Communication — request body — body associations item

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

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

Create — communications create Communication — 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, which can be 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or '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

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

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

List associations — communications 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 types with labels, detailing the nature of the associations with the target object. Each item in the array is an object of type AssociationSpecWithLabel.
associationTypes[]	Model	Each item	Expand List associations — communications 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 associations are made. It is a string.

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

List associations — communications get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	A string representing the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the object type ID from which the association originates.
label	string	Optional	A string representing the label for the association, which can be used to describe or categorize the association.
toObjectTypeId	string	Optional	A string representing the object type ID 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 — communications get Communications — 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 — communications get Communications — response body — paging
results	array	Required within parent	An array of simple public objects with associations. Each object includes its properties and associated data.
results[]	Model	Each item	Expand Read — communications get Communication — response body

Referenced models: List — communications get Communications — response body — paging, Read — communications get Communication — response body

List — communications get Communications — 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 — communications get Communications — response body — paging next

Referenced models: List — communications get Communications — response body — paging next

List — communications get Communications — 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 after the last item on the current page, used to fetch the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Merge objects — communications merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string identifier used for tracing write operations on this object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, where each value includes a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — communications 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 associated with 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 Merge objects — communications merge — response body — warnings item

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

Merge objects — communications 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.
sourceLabel	string	Optional	A string providing a human-readable label for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
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	A string representing the value at the given timestamp.

Merge objects — communications 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 containing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message, providing details about the issue.

Read — communications get Communication — 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 the CRM object is archived.
archivedAt	string	Optional	The date and time when the CRM object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their respective associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — communications get Communication — response body — associations value
createdAt	string	Required within parent	The date and time when the CRM object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the CRM object.
objectWriteTraceId	string	Optional	A string identifier used for tracing writes to the CRM object.
properties	object	Required within parent	A map of property names to their current values for the CRM object. 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, for the CRM object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — communications merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the CRM object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing the CRM object.
warnings	array	Optional	An array of warnings related to the CRM object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge objects — communications merge — response body — warnings item

Referenced models: Read — communications get Communication — response body — associations value, Merge objects — communications merge — response body — warnings item, Merge objects — communications merge — response body — properties With History value item

Read — communications get Communication — 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 — communications search Communications — 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 — products get Product — response body — associations value results item

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

Search — communications search Communications — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token to retrieve the next set of results after the current page.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for the search. Each filter group contains multiple filters that are combined using logical AND.
filterGroups[]	Model	Each item	Expand Search — communications search Communications — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. This value controls the size of the result set. Format: int32
properties	array	Required within parent	An array of strings indicating which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to filter the results based on specific terms.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property to sort by, optionally prefixed with '-' for descending order.
sorts[]	string	Each item

Referenced models: Search — communications search Communications — request body — body filter Groups item

Search — communications search Communications — 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 specify the criteria for filtering data. Each filter object includes details such as the property name, value, and operator to be used in the filtering process.
filters[]	Model	Each item	Expand Search — communications search Communications — request body — body filter Groups item filters item

Referenced models: Search — communications search Communications — request body — body filter Groups item filters item

Search — communications search Communications — 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-based filters, indicating the upper bound of the range.
operator	string	Required within parent	The operator used to compare the property with the specified 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 which the filter is applied. It is a string value.
value	string	Optional	The specific value to compare against the property when using the filter. It 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 — communications search Communications — 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 — communications search Communications — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual object in the collection.
results[]	Model	Each item	Expand Merge objects — communications 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 — communications search Communications — response body — paging, Merge objects — communications merge — response body

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

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

Update batch objects — communications batch Update Communications — 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 representing a single CRM object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update batch objects — communications batch Update Communications — request body — body inputs item

Referenced models: Update batch objects — communications batch Update Communications — request body — body inputs item

Update batch objects — communications batch Update Communications — 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 identifier used to trace the write operations for the objects in the batch.
properties	object	Required within parent	A map of property names to their values, used to define the attributes of the CRM objects in the batch. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — communications update Communication — 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 representing the properties of the CRM object. Each key is a property name, and each value is a string representing the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — communications batch Upsert Communications — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert items, each containing the details necessary to create or update a CRM object. Each item must include properties such as 'id' and 'properties'.
inputs[]	Model	Each item	Expand Upsert batch objects — communications batch Upsert Communications — request body — body inputs item

Referenced models: Upsert batch objects — communications batch Upsert Communications — request body — body inputs item

Upsert batch objects — communications batch Upsert Communications — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the CRM object.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operations 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

Upsert batch objects — communications.batchUpsertCommunications — 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created during the upsert operation.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of values with timestamps, representing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — communications 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 that provides access to 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 Merge objects — communications merge — response body — warnings item

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

Upsert batch objects — communications.batchUpsertCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Communications 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 context or resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items, each representing the result of an individual upsert operation within the batch.
results[]	Model	Each item	Expand Upsert batch objects — communications.batchUpsertCommunications — 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 — communications.batchUpsertCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — communications.batchUpsertCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Communications 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 Batch read objects — communications.batchGetCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or documentation about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — communications.batchUpsertCommunications — 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 read objects — communications.batchGetCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — communications.batchUpsertCommunications — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item