HubSpot: Conversations schemas

← Conversations operations · All schemas

Batch read actors — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of strings that are required for the batch operation. Each item in the array is a string.
inputs[]	string	Each item

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error condition, 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 further information about the error.
errors[]	Model	Each item	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING 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 with 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 the error message.
status	string	Required within parent	The status of the error as a string.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail.
context	object	Optional	Context about the error condition, represented as an object with additional properties. Each property is an array of strings providing further context. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human-readable message describing the error along with remediation steps where appropriate. This is a required field.
subCategory	string	Optional	A specific category that contains more specific detail about the error.

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor

Field	Type	Presence	Description and constraints
$	object	Root
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 their corresponding URIs, which may provide additional information 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 PublicActor objects representing the results of the batch operation.
results[]	Model	Each item	Expand Retrieve actor — 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: Retrieve actor — response body

Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Actor With Errors

Field	Type	Presence	Description and constraints
$	object	Root
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 encountered during the batch operation.
errors[]	Model	Each item	Expand Batch read actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	An object containing key-value pairs of link names to their associated URIs. 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 PublicActor objects representing the results of the batch operation.
results[]	Model	Each item	Expand Retrieve actor — 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 actors — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Retrieve actor — response body

Create message — request body — body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (oneOf 1)	Model	Alternative	Expand Create message — request body — body / type: MESSAGE
$ (oneOf 2)	Model	Alternative	Expand Create message — request body — body / type: COMMENT

Referenced models: Create message — request body — body / type: COMMENT, Create message — request body — body / type: MESSAGE

Create message — request body — body / type: COMMENT

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Required within parent	An array of attachments associated with the comment. Each attachment can be a file, quick reply, or social media metadata.
attachments[]	JSON	Each item
attachments[] (oneOf 1)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: FILE
attachments[] (oneOf 2)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES
attachments[] (oneOf 3)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA
richText	string	Optional	A string containing the rich text content of the comment, allowing for formatting.
text	string	Required within parent	A string containing the plain text content of the comment.
type	string	Required within parent	A string indicating the type of the object, which is 'COMMENT' by default. Default: COMMENT One of: COMMENT

Referenced models: Create message — request body — body / type: COMMENT attachments item type: FILE, Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES, Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA

Create message — request body — body / type: COMMENT attachments item type: FILE

Field	Type	Presence	Description and constraints
$	object	Root
fileId	string	Required within parent	A string representing the unique identifier of the file.
type	string	Required within parent	A string indicating the type of the component, which is always 'FILE'. Default: FILE One of: FILE

Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES

Field	Type	Presence	Description and constraints
$	object	Root
quickReplies	array	Required within parent	An array of QuickReply objects, each representing an individual quick reply option available to the user.
quickReplies[]	Model	Each item	Expand Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES quick Replies item
type	string	Required within parent	A string indicating the type of the component, which is 'QUICK_REPLIES'. Default: QUICK_REPLIES One of: QUICK_REPLIES

Referenced models: Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES quick Replies item

Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES quick Replies item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional	A human-readable label for the quick reply, displayed to the user.
value	string	Required within parent	The actual content or data of the quick reply, represented as a string.
valueType	string	Required within parent	Indicates the type of the value, which can be either 'TEXT' or 'URL'. One of: TEXT, URL

Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA

Field	Type	Presence	Description and constraints
$	object	Root
socialMetadata	Model	Required within parent	Expand Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata
type	string	Required within parent	A string that specifies the type of the component. The default value is 'SOCIAL_MEDIA_METADATA'. Default: SOCIAL_MEDIA_METADATA One of: SOCIAL_MEDIA_METADATA

Referenced models: Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata

Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the media content.
id	string	Optional	A unique identifier for the media.
mediaTitle	string	Optional	The title of the media content.
mediaType	string	Required within parent	The type of media represented, such as 'PHOTO', 'VIDEO', 'CAROUSEL', etc. This is a required field. One of: ARTICLE, AUDIO, CAROUSEL, DOCUMENT, GIF, LINK, NONE, PHOTO, POLL, STORY, VIDEO
mediaUrl	string	Optional	The URL where the media can be accessed.
mediaUrlString	string	Optional	A string representing the URL of the media.
thumbnailUrl	string	Optional	The URL of the thumbnail image for the media.

Create message — request body — body / type: MESSAGE

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Required within parent	An array of attachments associated with the message. Each attachment can be a file, quick reply, or social media metadata.
attachments[]	JSON	Each item
attachments[] (oneOf 1)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: FILE
attachments[] (oneOf 2)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES
attachments[] (oneOf 3)	Model	Alternative	Expand Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA
channelAccountId	string	Required within parent	A string representing the unique identifier of the channel account used to send the message.
channelId	string	Required within parent	A string representing the unique identifier of the channel through which the message is sent.
recipients	array	Required within parent	An array of recipient objects representing the intended recipients of the message.
recipients[]	Model	Each item	Expand Create message — request body — body / type: MESSAGE recipients item
richText	string	Optional	A string containing the rich text content of the message.
senderActorId	string	Required within parent	A string representing the unique identifier of the sender actor.
subject	string	Optional	A string representing the subject of the message.
text	string	Required within parent	A string containing the plain text content of the message.
type	string	Required within parent	A string indicating the type of message. The default value is 'MESSAGE'. Default: MESSAGE One of: MESSAGE

Referenced models: Create message — request body — body / type: COMMENT attachments item type: FILE, Create message — request body — body / type: COMMENT attachments item type: QUICK REPLIES, Create message — request body — body / type: MESSAGE recipients item, Create message — request body — body / type: COMMENT attachments item type: SOCIAL MEDIA METADATA

Create message — request body — body / type: MESSAGE recipients item

Field	Type	Presence	Description and constraints
$	object	Root
actorId	string	Optional	The unique identifier for the actor, represented as a string.
deliveryIdentifier	Model	Optional	Expand Create message — request body — body / type: MESSAGE recipients item delivery Identifier
deliveryIdentifiers	array	Required within parent	An array of delivery identifiers, each represented by a PublicDeliveryIdentifier object, used to specify the methods or channels through which the recipient can receive messages.
deliveryIdentifiers[]	Model	Each item	Expand Create message — request body — body / type: MESSAGE recipients item delivery Identifier
name	string	Optional	The name of the recipient, represented as a string.
recipientField	string	Optional	A field associated with the recipient, represented as a string.

Referenced models: Create message — request body — body / type: MESSAGE recipients item delivery Identifier

Create message — request body — body / type: MESSAGE recipients item delivery Identifier

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string indicating the type of delivery identifier. Valid values include 'HS_EMAIL_ADDRESS', 'HS_PHONE_NUMBER', 'HS_SHORT_CODE', and 'CHANNEL_SPECIFIC_OPAQUE_ID'. One of: CHANNEL_SPECIFIC_OPAQUE_ID, HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE
value	string	Required within parent	A string representing the actual value of the delivery identifier, such as an email address or phone number.

Create message — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE
$ (anyOf 2)	Model	Alternative	Expand Create message — response body — type: COMMENT
$ (anyOf 3)	Model	Alternative	Expand Create message — response body — type: WELCOME MESSAGE
$ (anyOf 4)	Model	Alternative	Expand Create message — response body — type: ASSIGNMENT
$ (anyOf 5)	Model	Alternative	Expand Create message — response body — newStatus: CLOSED, OPEN, type: THREAD STATUS CHANGE
$ (anyOf 6)	Model	Alternative	Expand Create message — response body — type: THREAD INBOX CHANGE

Referenced models: Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE, Create message — response body — type: ASSIGNMENT, Create message — response body — type: COMMENT, Create message — response body — type: THREAD INBOX CHANGE, Create message — response body — newStatus: CLOSED, OPEN, type: THREAD STATUS CHANGE, Create message — response body — type: WELCOME MESSAGE

Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether this message is archived.
attachments	array	Required within parent	An array of attachments included with this message, which can be of various types such as files, locations, or social media metadata.
attachments[]	JSON	Each item
attachments[] (anyOf 1)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item file Usage Type: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE
attachments[] (anyOf 2)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: LOCATION
attachments[] (anyOf 3)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: CONTACT
attachments[] (anyOf 4)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: UNSUPPORTED CONTENT
attachments[] (anyOf 5)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: MESSAGE HEADER
attachments[] (anyOf 6)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: QUICK REPLIES
attachments[] (anyOf 7)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: WHATSAPP TEMPLATE METADATA
attachments[] (anyOf 8)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA
channelAccountId	string	Required within parent	The identifier of the channel account associated with this message.
channelId	string	Required within parent	The identifier of the channel through which this message was sent.
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The identifier of the conversation thread to which this message belongs.
createdAt	string	Required within parent	The date and time when this message was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the actor who created this message.
direction	string	Required within parent	The direction of the message, indicating whether it is 'INCOMING' or 'OUTGOING'. Known values: INCOMING, OUTGOING
id	string	Required within parent	The unique identifier for this message.
inReplyToId	string	Optional	The identifier of the message to which this message is a reply, if applicable.
recipients	array	Required within parent	An array of recipients of this message, each represented as a PublicRecipient object.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
richText	string	Optional	The rich text content of the message, which may include formatting.
senders	array	Required within parent	An array of senders involved in this message, each represented as a PublicSender object.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
status	Model	Optional	Expand Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status
subject	string	Optional	The subject of the message, if applicable.
text	string	Required within parent	The plain text content of the message.
truncationStatus	string	Required within parent	Indicates the truncation status of the message content, with possible values being 'NOT_TRUNCATED', 'TRUNCATED_TO_MOST_RECENT_REPLY', or 'TRUNCATED'. Known values: NOT_TRUNCATED, TRUNCATED, TRUNCATED_TO_MOST_RECENT_REPLY
type	string	Required within parent	The type of the message, which is always 'MESSAGE'. Known values: MESSAGE Default: MESSAGE
updatedAt	string	Optional	The date and time when this message was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT attachments item type: CONTACT, Create message — response body — type: COMMENT attachments item file Usage Type: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE, Create message — response body — type: COMMENT attachments item type: LOCATION, Create message — response body — type: COMMENT attachments item type: MESSAGE HEADER, Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status, Create message — response body — type: COMMENT attachments item type: QUICK REPLIES, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item, Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA, Create message — response body — type: COMMENT attachments item type: UNSUPPORTED CONTENT, Create message — response body — type: COMMENT attachments item type: WHATSAPP TEMPLATE METADATA

Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status

Field	Type	Presence	Description and constraints
$	object	Root
failureDetails	Model	Optional	Expand Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status failure Details
statusType	string	Required within parent	The type of status for the message. Valid values include 'SENT', 'FAILED', 'RECEIVED', and 'READ'. Known values: FAILED, READ, RECEIVED, SENT

Referenced models: Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status failure Details

Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE status failure Details

Field	Type	Presence	Description and constraints
$	object	Root
errorMessage	string	Optional	A string containing a description of the error encountered during message processing.
errorMessageTokens	object	Required within parent	An object containing key-value pairs where each key is a token name and each value is a string. These tokens provide additional context or details related to the error message. Additional keys: see wildcard field
errorMessageTokens.*	string	Additional keys

Create message — response body — newStatus: CLOSED, OPEN, type: THREAD STATUS CHANGE

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether this status change has been archived.
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The unique identifier of the conversation thread whose status is being changed.
createdAt	string	Required within parent	The date and time when this status change was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the user or system that created this status change.
id	string	Required within parent	The unique identifier for this status change.
newStatus	string	Required within parent	A string representing the new status of the thread. Valid values include 'OPEN' and 'CLOSED'. Known values: CLOSED, OPEN
recipients	array	Required within parent	An array of objects representing the recipients involved in this status change.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
senders	array	Required within parent	An array of objects representing the senders involved in this status change.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
type	string	Required within parent	A string indicating the type of change. Defaults to 'THREAD_STATUS_CHANGE'. Known values: THREAD_STATUS_CHANGE Default: THREAD_STATUS_CHANGE
updatedAt	string	Optional	The date and time when this status change was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item

Create message — response body — type: ASSIGNMENT

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether this message is archived.
assignedFrom	string	Optional	The identifier of the actor from whom the conversation was assigned.
assignedTo	string	Optional	The identifier of the actor to whom the conversation is assigned.
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The unique identifier of the conversation thread associated with this message.
createdAt	string	Required within parent	The date and time when this message was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the actor who created this message.
id	string	Required within parent	The unique identifier for this assignment message.
recipients	array	Required within parent	An array of recipients involved in this message, each represented by a PublicRecipient object.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
senders	array	Required within parent	An array of senders involved in this message, each represented by a PublicSender object.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
type	string	Required within parent	The type of message, which is 'ASSIGNMENT'. Known values: ASSIGNMENT Default: ASSIGNMENT
updatedAt	string	Optional	The date and time when this message was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item

Create message — response body — type: COMMENT

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the comment is archived.
attachments	array	Required within parent	An array of attachments associated with the comment, which can include files, locations, contacts, and other types of content.
attachments[]	JSON	Each item
attachments[] (anyOf 1)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item file Usage Type: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE
attachments[] (anyOf 2)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: LOCATION
attachments[] (anyOf 3)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: CONTACT
attachments[] (anyOf 4)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: UNSUPPORTED CONTENT
attachments[] (anyOf 5)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: MESSAGE HEADER
attachments[] (anyOf 6)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: QUICK REPLIES
attachments[] (anyOf 7)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: WHATSAPP TEMPLATE METADATA
attachments[] (anyOf 8)	Model	Alternative	Expand Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The unique identifier of the conversation thread to which this comment belongs.
createdAt	string	Required within parent	The date and time when the comment was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the user who created the comment.
id	string	Required within parent	The unique identifier for the comment.
recipients	array	Required within parent	An array of recipients associated with the comment, each represented by a PublicRecipient object.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
richText	string	Required within parent	The rich text content of the comment, which may include formatting.
senders	array	Required within parent	An array of senders associated with the comment, each represented by a PublicSender object.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
text	string	Required within parent	The plain text content of the comment.
type	string	Required within parent	The type of the message, which is always 'COMMENT' for this component. Known values: COMMENT Default: COMMENT
updatedAt	string	Optional	The date and time when the comment was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT attachments item type: CONTACT, Create message — response body — type: COMMENT attachments item file Usage Type: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE, Create message — response body — type: COMMENT attachments item type: LOCATION, Create message — response body — type: COMMENT attachments item type: MESSAGE HEADER, Create message — response body — type: COMMENT attachments item type: QUICK REPLIES, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item, Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA, Create message — response body — type: COMMENT attachments item type: UNSUPPORTED CONTENT, Create message — response body — type: COMMENT attachments item type: WHATSAPP TEMPLATE METADATA

Create message — response body — type: COMMENT attachments item file Usage Type: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE

Field	Type	Presence	Description and constraints
$	object	Root
fileId	string	Required within parent	A string representing the unique identifier for the file.
fileUsageType	string	Required within parent	A string indicating the usage type of the file. Valid values include 'STICKER', 'VOICE_RECORDING', 'IMAGE', 'AUDIO', and 'OTHER'. Known values: AUDIO, IMAGE, OTHER, STICKER, VOICE_RECORDING
name	string	Optional	A string representing the name of the file.
type	string	Required within parent	A string indicating the type of the object, which is 'FILE' by default. Known values: FILE Default: FILE
url	string	Optional	A string representing the URL where the file can be accessed.

Create message — response body — type: COMMENT attachments item type: CONTACT

Field	Type	Presence	Description and constraints
$	object	Root
contactProfile	Model	Required within parent	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile
type	string	Required within parent	A string indicating the type of the object, which is 'CONTACT' by default. Known values: CONTACT Default: CONTACT

Referenced models: Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile

Field	Type	Presence	Description and constraints
$	object	Root
addresses	array	Required within parent	An array of addresses associated with the contact, where each address includes type (e.g., HOME, WORK), street, city, state, zip, country, and country code.
addresses[]	Model	Each item	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile addresses item
emails	array	Required within parent	An array of email addresses associated with the contact, where each email includes type (e.g., HOME, WORK) and the email address itself.
emails[]	Model	Each item	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile emails item
name	Model	Optional	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile name
org	Model	Optional	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile org
phones	array	Required within parent	An array of phone numbers associated with the contact, where each phone number includes type (e.g., CELL, MAIN, HOME, WORK) and the phone number itself.
phones[]	Model	Each item	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile phones item
urls	array	Required within parent	An array of URLs associated with the contact, where each URL includes type (e.g., HOME, WORK) and the URL itself.
urls[]	Model	Each item	Expand Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile urls item

Referenced models: Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile name, Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile org, Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile addresses item, Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile emails item, Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile phones item, Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile urls item

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile addresses item

Field	Type	Presence	Description and constraints
$	object	Root
city	string	Optional	The city where the contact is located. It is a string representing the city name.
country	string	Optional	The country where the contact is located. It is a string representing the country name.
countryCode	string	Optional	The code representing the country of the contact. It is a string, typically an ISO 3166-1 alpha-2 country code.
state	string	Optional	The state or region where the contact is located. It is a string representing the state or region name.
street	string	Optional	The street address of the contact. It is a string representing the street name and number.
type	string	Optional	The type of address, indicating whether it is a 'HOME' or 'WORK' address. Known values: HOME, WORK
zip	string	Optional	The postal code for the contact's address. It is a string representing the ZIP or postal code.

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile emails item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the contact. This is a required field.
type	string	Optional	The type of email address, which can be either 'HOME' or 'WORK'. Known values: HOME, WORK

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile name

Field	Type	Presence	Description and constraints
$	object	Root
firstName	string	Optional	A string representing the first name of the contact.
lastName	string	Optional	A string representing the last name of the contact.
middleName	string	Optional	An optional string representing the middle name of the contact.
prefix	string	Optional	An optional string representing the prefix of the contact's name, such as 'Mr.', 'Ms.', or 'Dr.'.
suffix	string	Optional	An optional string representing the suffix of the contact's name, such as 'Jr.', 'Sr.', or 'III'.

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile org

Field	Type	Presence	Description and constraints
$	object	Root
company	string	Optional	The name of the company the contact is associated with.
department	string	Optional	The department within the company where the contact works.
title	string	Optional	The professional title or position held by the contact within the company.

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile phones item

Field	Type	Presence	Description and constraints
$	object	Root
phone	string	Required within parent	The phone number associated with the contact. This is a required field.
type	string	Optional	The type of phone, which can be 'CELL', 'MAIN', 'HOME', or 'WORK'. Known values: CELL, HOME, MAIN, WORK

Create message — response body — type: COMMENT attachments item type: CONTACT contact Profile urls item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Optional	The type of URL, which can be either 'HOME' or 'WORK'. Known values: HOME, WORK
url	string	Required within parent	The actual URL string associated with the contact.

Create message — response body — type: COMMENT attachments item type: LOCATION

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	A string providing the address of the location.
latitude	JSON	Required within parent
latitude (anyOf 1)	number	Alternative	A number indicating the latitude of the location.
latitude (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitude	JSON	Required within parent
longitude (anyOf 1)	number	Alternative	A number indicating the longitude of the location.
longitude (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Optional	A string representing the name of the location.
type	string	Required within parent	A string representing the type of the component, which is 'LOCATION' by default. Known values: LOCATION Default: LOCATION
url	string	Optional	A string containing a URL associated with the location.

Create message — response body — type: COMMENT attachments item type: MESSAGE HEADER

Field	Type	Presence	Description and constraints
$	object	Root
fileId	JSON	Optional
fileId (anyOf 1)	integer	Alternative	An integer representing the ID of a file associated with the message header, formatted as an int64. Format: int64
fileId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
text	string	Optional	A string containing the text content of the message header.
type	string	Required within parent	A string indicating the type of the message header. The default and only valid value is 'MESSAGE_HEADER'. Known values: MESSAGE_HEADER Default: MESSAGE_HEADER

Create message — response body — type: COMMENT attachments item type: QUICK REPLIES

Field	Type	Presence	Description and constraints
$	object	Root
allowMultiSelect	boolean	Required within parent	A boolean indicating whether the user can select multiple quick replies at once.
allowUserInput	boolean	Required within parent	A boolean indicating whether the user is allowed to input their own response in addition to selecting from the quick replies.
quickReplies	array	Required within parent	An array of QuickReply objects, each representing a single quick reply option available to the user.
quickReplies[]	Model	Each item	Expand Create message — response body — type: COMMENT attachments item type: QUICK REPLIES quick Replies item
type	string	Required within parent	A string indicating the type of the component, with a default value of 'QUICK_REPLIES'. Known values: QUICK_REPLIES Default: QUICK_REPLIES

Referenced models: Create message — response body — type: COMMENT attachments item type: QUICK REPLIES quick Replies item

Create message — response body — type: COMMENT attachments item type: QUICK REPLIES quick Replies item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional	A human-readable label for the quick reply, displayed to the user.
value	string	Required within parent	The actual content or data of the quick reply, represented as a string.
valueType	string	Required within parent	Indicates the type of the value, which can be either 'TEXT' or 'URL'. Known values: TEXT, URL

Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA

Field	Type	Presence	Description and constraints
$	object	Root
socialMetadata	Model	Required within parent	Expand Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata
type	string	Required within parent	A string indicating the type of metadata, which is always 'SOCIAL_MEDIA_METADATA'. Known values: SOCIAL_MEDIA_METADATA Default: SOCIAL_MEDIA_METADATA

Referenced models: Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata

Create message — response body — type: COMMENT attachments item type: SOCIAL MEDIA METADATA social Metadata

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the media content.
id	string	Optional	A unique identifier for the media.
mediaTitle	string	Optional	The title of the media content.
mediaType	string	Required within parent	The type of media represented, such as 'PHOTO', 'VIDEO', 'CAROUSEL', etc. This is a required field. Known values: ARTICLE, AUDIO, CAROUSEL, DOCUMENT, GIF, LINK, NONE, PHOTO, POLL, STORY, VIDEO
mediaUrl	string	Optional	The URL where the media can be accessed.
mediaUrlString	string	Optional	A string representing the URL of the media.
thumbnailUrl	string	Optional	The URL of the thumbnail image for the media.

Create message — response body — type: COMMENT attachments item type: UNSUPPORTED CONTENT

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string indicating the type of content. The default value is 'UNSUPPORTED_CONTENT', and it must be 'UNSUPPORTED_CONTENT'. Known values: UNSUPPORTED_CONTENT Default: UNSUPPORTED_CONTENT

Create message — response body — type: COMMENT attachments item type: WHATSAPP TEMPLATE METADATA

Field	Type	Presence	Description and constraints
$	object	Root
contentId	JSON	Optional
contentId (anyOf 1)	integer	Alternative	An integer representing the ID of the content associated with the template. This is a 64-bit integer. Format: int64
contentId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
crmObjectIds	object	Required within parent	An object that maps CRM object names to their respective IDs, where each ID is a 64-bit integer. Additional keys: see wildcard field
crmObjectIds.*	JSON	Additional keys
crmObjectIds.* (anyOf 1)	integer	Alternative	Format: int64
crmObjectIds.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mappedTemplateId	JSON	Optional
mappedTemplateId (anyOf 1)	integer	Alternative	An integer representing the ID of the mapped template. This is a 64-bit integer. Format: int64
mappedTemplateId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parameters	object	Required within parent	An object containing key-value pairs where each key is a parameter name and each value is a string representing the parameter value. Additional keys: see wildcard field
parameters.*	string	Additional keys
rootMicId	JSON	Optional
rootMicId (anyOf 1)	integer	Alternative	An integer representing the root MIC ID associated with the template. This is a 64-bit integer. Format: int64
rootMicId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	A string representing the type of the metadata, which is always 'WHATSAPP_TEMPLATE_METADATA'. Known values: WHATSAPP_TEMPLATE_METADATA Default: WHATSAPP_TEMPLATE_METADATA

Create message — response body — type: COMMENT client

Field	Type	Presence	Description and constraints
$	object	Root
clientType	string	Required within parent	The type of client interacting with the API. Valid values include 'HUBSPOT', 'SYSTEM', 'INTEGRATION', and 'UNKNOWN'. Known values: HUBSPOT, INTEGRATION, SYSTEM, UNKNOWN
integrationAppId	JSON	Optional
integrationAppId (anyOf 1)	integer	Alternative	An optional identifier for the integration application associated with the client. It is an integer value. Format: int32
integrationAppId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create message — response body — type: COMMENT recipients item

Field	Type	Presence	Description and constraints
$	object	Root
actorId	string	Optional	The unique identifier for the actor, represented as a string.
deliveryIdentifier	Model	Required within parent	Expand Retrieve Channel Account — response body — delivery Identifier
name	string	Optional	The name of the recipient, represented as a string.
recipientField	string	Optional	A string representing a specific field related to the recipient.

Referenced models: Retrieve Channel Account — response body — delivery Identifier

Create message — response body — type: COMMENT senders item

Field	Type	Presence	Description and constraints
$	object	Root
actorId	string	Optional	The unique identifier for the sender, represented as a string.
deliveryIdentifier	Model	Optional	Expand Retrieve Channel Account — response body — delivery Identifier
name	string	Optional	The name of the sender, represented as a string.
senderField	string	Optional	A string field associated with the sender, purpose unspecified.

Referenced models: Retrieve Channel Account — response body — delivery Identifier

Create message — response body — type: THREAD INBOX CHANGE

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether this inbox change event has been archived.
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The unique identifier for the conversation thread associated with this inbox change.
createdAt	string	Required within parent	The date and time when this inbox change was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the user or system that created this inbox change.
fromInboxId	string	Required within parent	The unique identifier of the inbox from which the thread is moved.
id	string	Required within parent	The unique identifier for this inbox change event.
recipients	array	Required within parent	An array of objects representing the recipients involved in the conversation thread.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
senders	array	Required within parent	An array of objects representing the senders involved in the conversation thread.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
toInboxId	string	Required within parent	The unique identifier of the inbox to which the thread is moved.
type	string	Required within parent	A string indicating the type of change, which is 'THREAD_INBOX_CHANGE'. Known values: THREAD_INBOX_CHANGE Default: THREAD_INBOX_CHANGE
updatedAt	string	Optional	The date and time when this inbox change was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item

Create message — response body — type: WELCOME MESSAGE

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether this welcome message is archived.
channelAccountId	string	Required within parent	The unique identifier for the channel account associated with this welcome message.
channelId	string	Required within parent	The unique identifier for the channel through which this welcome message is sent.
client	Model	Required within parent	Expand Create message — response body — type: COMMENT client
conversationsThreadId	string	Required within parent	The unique identifier for the conversation thread to which this welcome message belongs.
createdAt	string	Required within parent	The date and time when this welcome message was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the user or system that created this welcome message.
id	string	Required within parent	The unique identifier for this welcome message.
recipients	array	Required within parent	An array of objects representing the recipients of this welcome message.
recipients[]	Model	Each item	Expand Create message — response body — type: COMMENT recipients item
richText	string	Optional	The rich text content of the welcome message, which may include formatting.
senders	array	Required within parent	An array of objects representing the senders of this welcome message.
senders[]	Model	Each item	Expand Create message — response body — type: COMMENT senders item
text	string	Required within parent	The plain text content of the welcome message.
type	string	Required within parent	A string indicating the type of message, which is 'WELCOME_MESSAGE' by default. Known values: WELCOME_MESSAGE Default: WELCOME_MESSAGE
updatedAt	string	Optional	The date and time when this welcome message was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create message — response body — type: COMMENT client, Create message — response body — type: COMMENT recipients item, Create message — response body — type: COMMENT senders item

List Inboxes — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Inboxes — response body — paging
results	array	Required within parent	An array of public inbox objects, each representing a single inbox with its details.
results[]	Model	Each item	Expand Retrieve inbox — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of public inboxes available. It is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Inboxes — response body — paging, Retrieve inbox — response body

List Inboxes — 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 Inboxes — response body — paging next
prev	Model	Optional	Expand List Inboxes — response body — paging prev

Referenced models: List Inboxes — response body — paging next, List Inboxes — response body — paging prev

List Inboxes — 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 to fetch the next set of results in a paginated response.
link	string	Optional	A string containing the URL link to the next page of results.

List Inboxes — 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 links to the previous page of results.

List channel accounts — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Inboxes — response body — paging
results	array	Required within parent	An array of public channel account objects, each containing details about a specific channel account.
results[]	Model	Each item	Expand Retrieve Channel Account — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of public channel accounts available. It is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Inboxes — response body — paging, Retrieve Channel Account — response body

List channels — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Inboxes — response body — paging
results	array	Required within parent	An array containing the public channel objects. Each item in the array is a reference to a PublicChannel schema.
results[]	Model	Each item	Expand Retrieve channel — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of public channels available. It is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Inboxes — response body — paging, Retrieve channel — response body

List threads — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List threads — response body — paging
results	array	Required within parent	An array of PublicThread objects, representing the individual threads in the collection.
results[]	Model	Each item	Expand Update thread — response body

Referenced models: List threads — response body — paging, Update thread — response body

List threads — 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 Inboxes — response body — paging next

Referenced models: List Inboxes — response body — paging next

Retrieve Channel Account — response body

Field	Type	Presence	Description and constraints
$	object	Root
active	boolean	Required within parent	A boolean indicating whether the channel account is currently active.
archived	boolean	Required within parent	A boolean indicating whether the channel account is archived.
archivedAt	string	Optional	The date and time when the channel account was archived, in ISO 8601 format. Format: date-time
authorized	boolean	Required within parent	A boolean indicating whether the channel account is authorized.
channelId	string	Required within parent	The unique identifier for the channel associated with this account, represented as a string.
createdAt	string	Required within parent	The date and time when the channel account was created, in ISO 8601 format. Format: date-time
deliveryIdentifier	Model	Optional	Expand Retrieve Channel Account — response body — delivery Identifier
id	string	Required within parent	The unique identifier for the channel account, represented as a string.
inboxId	string	Required within parent	The unique identifier for the inbox associated with this channel account, represented as a string.
name	string	Required within parent	The name of the channel account, represented as a string.

Referenced models: Retrieve Channel Account — response body — delivery Identifier

Retrieve Channel Account — response body — delivery Identifier

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string indicating the type of delivery identifier. Valid values include 'HS_EMAIL_ADDRESS', 'HS_PHONE_NUMBER', 'HS_SHORT_CODE', and 'CHANNEL_SPECIFIC_OPAQUE_ID'. Known values: CHANNEL_SPECIFIC_OPAQUE_ID, HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE
value	string	Required within parent	A string representing the actual value of the delivery identifier, such as an email address or phone number.

Retrieve actor — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Retrieve actor — response body — type: AGENT
$ (anyOf 2)	Model	Alternative	Expand Retrieve actor — response body — type: BOT
$ (anyOf 3)	Model	Alternative	Expand Retrieve actor — response body — type: INTEGRATOR
$ (anyOf 4)	Model	Alternative	Expand Retrieve actor — response body — type: SYSTEM
$ (anyOf 5)	Model	Alternative	Expand Retrieve actor — response body — type: VISITOR
$ (anyOf 6)	Model	Alternative	Expand Retrieve actor — response body — type: EMAIL
$ (anyOf 7)	Model	Alternative	Expand Retrieve actor — response body — type: LLM

Referenced models: Retrieve actor — response body — type: AGENT, Retrieve actor — response body — type: BOT, Retrieve actor — response body — type: EMAIL, Retrieve actor — response body — type: INTEGRATOR, Retrieve actor — response body — type: LLM, Retrieve actor — response body — type: SYSTEM, Retrieve actor — response body — type: VISITOR

Retrieve actor — response body — type: AGENT

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL to the avatar image of the agent.
email	string	Optional	A string containing the email address of the agent.
id	string	Required within parent	A string that uniquely identifies the agent actor.
name	string	Optional	A string representing the name of the agent.
type	string	Required within parent	A string representing the type of actor, which is always 'AGENT' for this component. Known values: AGENT Default: AGENT

Retrieve actor — response body — type: BOT

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL of the avatar image for the bot actor.
id	string	Required within parent	A string representing the unique identifier for the bot actor.
name	string	Optional	A string representing the name of the bot actor.
type	string	Required within parent	A string indicating the type of actor, which is always 'BOT' for this component. Known values: BOT Default: BOT

Retrieve actor — response body — type: EMAIL

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	A string containing the email address associated with the actor.
id	string	Required within parent	A string that uniquely identifies the email actor.
type	string	Required within parent	A string representing the type of actor, which defaults to 'EMAIL'. Known values: EMAIL Default: EMAIL

Retrieve actor — response body — type: INTEGRATOR

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string containing the URL or identifier for the avatar image of the integrator actor.
id	string	Required within parent	A string that uniquely identifies the integrator actor.
name	string	Required within parent	A string representing the name of the integrator actor.
type	string	Required within parent	A string representing the type of actor, with the default value 'INTEGRATOR'. Known values: INTEGRATOR Default: INTEGRATOR

Retrieve actor — response body — type: LLM

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL of the avatar image for the LLM actor.
id	string	Required within parent	A unique identifier for the LLM actor, represented as a string.
name	string	Optional	The name of the LLM actor, represented as a string.
type	string	Required within parent	A string indicating the type of actor, which is always 'LLM' for this component. Known values: LLM Default: LLM

Retrieve actor — response body — type: SYSTEM

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	A string that uniquely identifies the system actor.
type	string	Required within parent	A string that specifies the type of actor, which is 'SYSTEM' for this component. Known values: SYSTEM Default: SYSTEM

Retrieve actor — response body — type: VISITOR

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL of the visitor's avatar image.
email	string	Optional	A string containing the email address of the visitor.
id	string	Required within parent	A string representing the unique identifier for the visitor actor.
name	string	Optional	A string containing the name of the visitor.
type	string	Required within parent	A string indicating the type of actor, which is 'VISITOR' for this component. Known values: VISITOR Default: VISITOR

Retrieve channel — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the channel, represented as a string.
name	string	Required within parent	The name of the channel, represented as a string.

Retrieve inbox — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the inbox is archived.
archivedAt	string	Optional	The date and time when the inbox was archived, in ISO 8601 format. This property is optional. Format: date-time
createdAt	string	Required within parent	The date and time when the inbox was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the inbox. It is a string.
name	string	Required within parent	The name of the inbox. It is a string.
type	string	Required within parent	The type of the inbox, which can be either 'INBOX' or 'HELP_DESK'. Known values: HELP_DESK, INBOX
updatedAt	string	Required within parent	The date and time when the inbox was last updated, in ISO 8601 format. Format: date-time

Retrieve messages — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List threads — response body — paging
results	array	Required within parent	An array of public messages, which can include various types such as conversations messages, comments, welcome messages, assignment messages, thread status changes, and thread inbox changes.
results[]	JSON	Each item
results[] (anyOf 1)	Model	Alternative	Expand Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE
results[] (anyOf 2)	Model	Alternative	Expand Create message — response body — type: COMMENT
results[] (anyOf 3)	Model	Alternative	Expand Create message — response body — type: WELCOME MESSAGE
results[] (anyOf 4)	Model	Alternative	Expand Create message — response body — type: ASSIGNMENT
results[] (anyOf 5)	Model	Alternative	Expand Create message — response body — newStatus: CLOSED, OPEN, type: THREAD STATUS CHANGE
results[] (anyOf 6)	Model	Alternative	Expand Create message — response body — type: THREAD INBOX CHANGE

Referenced models: List threads — response body — paging, Create message — response body — direction: INCOMING, OUTGOING, truncation Status: NOT TRUNCATED, TRUNCATED, TRUNCATED TO MOST RECENT REPLY, type: MESSAGE, Create message — response body — type: ASSIGNMENT, Create message — response body — type: COMMENT, Create message — response body — type: THREAD INBOX CHANGE, Create message — response body — newStatus: CLOSED, OPEN, type: THREAD STATUS CHANGE, Create message — response body — type: WELCOME MESSAGE

Retrieve original content — response body

Field	Type	Presence	Description and constraints
$	object	Root
richText	string	Optional	A string representing the rich text content of the message, which may include formatting and other rich text features.
text	string	Optional	A string representing the plain text content of the message.

Update assignee — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
actorId	string	Required within parent	The unique identifier of the actor to be assigned to the thread. It is a required string property.

Update thread — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean indicating whether the thread is archived.
status	string	Optional	The current status of the thread. Valid values include 'OPEN' and 'CLOSED'. One of: CLOSED, OPEN

Update thread — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the thread is archived.
assignedTo	string	Optional	The identifier of the user to whom the thread is assigned.
associatedContactId	string	Required within parent	The identifier of the contact associated with the thread.
closedAt	string	Optional	The date and time when the thread was closed, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the thread was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the conversation thread.
inboxId	string	Required within parent	The identifier of the inbox where the thread is located.
latestMessageReceivedTimestamp	string	Optional	The date and time when the latest message was received, in ISO 8601 format. Format: date-time
latestMessageSentTimestamp	string	Optional	The date and time when the latest message was sent, in ISO 8601 format. Format: date-time
latestMessageTimestamp	string	Optional	The date and time of the latest message in the thread, in ISO 8601 format. Format: date-time
originalChannelAccountId	string	Required within parent	The identifier of the original channel account associated with the thread.
originalChannelId	string	Required within parent	The identifier of the original channel where the thread was initiated.
spam	boolean	Required within parent	A boolean indicating whether the thread is marked as spam.
status	string	Required within parent	The current status of the thread. Valid values include 'OPEN' and 'CLOSED'. Known values: CLOSED, OPEN
threadAssociations	Model	Optional	Expand Update thread — response body — thread Associations

Referenced models: Update thread — response body — thread Associations

Update thread — response body — thread Associations

Field	Type	Presence	Description and constraints
$	object	Root
associatedTicketId	string	Optional	The unique identifier for the associated ticket, represented as a string.