HubSpot: Custom channels schemas

← Custom channels operations · All schemas

Create a channel account — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
authorized	boolean	Required within parent	A boolean indicating whether the channel account is authorized.
deliveryIdentifier	Model	Optional	Expand Create a channel account — request body — body delivery Identifier
inboxId	string	Required within parent	The unique identifier for the inbox associated with this channel account. It is a string.
name	string	Required within parent	The name of the channel account. It is a string.

Referenced models: Create a channel account — request body — body delivery Identifier

Create a channel account — request body — body delivery Identifier

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string representing 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 value associated with the delivery identifier type.

Create a 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 to which this account belongs, 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 Create a channel account — response body — delivery Identifier
id	string	Required within parent	The unique identifier for this 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: Create a channel account — response body — delivery Identifier

Create a channel account — response body — delivery Identifier

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string representing 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 value associated with the delivery identifier type.

Get a message — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the message is archived.
attachments	array	Required within parent	An array of attachments included with the message, which can be files, locations, contacts, or other supported types.
attachments[]	JSON	Each item
attachments[] (anyOf 1)	Model	Alternative	Expand Get a message — response body — attachments / item / fileUsageType: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE
attachments[] (anyOf 2)	Model	Alternative	Expand Get a message — response body — attachments / item / type: LOCATION
attachments[] (anyOf 3)	Model	Alternative	Expand Get a message — response body — attachments / item / type: CONTACT
attachments[] (anyOf 4)	Model	Alternative	Expand Get a message — response body — attachments / item / type: UNSUPPORTED CONTENT
attachments[] (anyOf 5)	Model	Alternative	Expand Get a message — response body — attachments / item / type: MESSAGE HEADER
attachments[] (anyOf 6)	Model	Alternative	Expand Get a message — response body — attachments / item / type: QUICK REPLIES
attachments[] (anyOf 7)	Model	Alternative	Expand Get a message — response body — attachments / item / type: WHATSAPP TEMPLATE METADATA
attachments[] (anyOf 8)	Model	Alternative	Expand Get a message — response body — attachments / item / type: SOCIAL MEDIA METADATA
channelAccountId	string	Required within parent	The identifier of the channel account associated with the message.
channelId	string	Required within parent	The identifier of the channel through which the message was sent.
client	Model	Required within parent	Expand Get a message — response body — client
conversationsThreadId	string	Required within parent	The identifier for the conversation thread to which this message belongs.
createdAt	string	Required within parent	The date and time when the message was created, in ISO 8601 format. Format: date-time
createdBy	string	Required within parent	The identifier of the user or system that created the message.
direction	string	Required within parent	The direction of the message, either 'INCOMING' or 'OUTGOING'. Known values: INCOMING, OUTGOING
id	string	Required within parent	The unique identifier for the 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 the message, each containing recipient details.
recipients[]	Model	Each item	Expand Get a message — response body — recipients item
richText	string	Optional	The rich text content of the message, if available.
senders	array	Required within parent	An array of senders associated with the message, each containing sender details.
senders[]	Model	Each item	Expand Get a message — response body — senders item
status	Model	Optional	Expand Get a message — response body — 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 whether the message content is truncated. Valid values are 'NOT_TRUNCATED', 'TRUNCATED_TO_MOST_RECENT_REPLY', and '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 the message was last updated, in ISO 8601 format. Format: date-time

Referenced models: Get a message — response body — client, Get a message — response body — attachments / item / type: CONTACT, Get a message — response body — attachments / item / fileUsageType: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE, Get a message — response body — attachments / item / type: LOCATION, Get a message — response body — attachments / item / type: MESSAGE HEADER, Get a message — response body — status, Get a message — response body — attachments / item / type: QUICK REPLIES, Get a message — response body — recipients item, Get a message — response body — senders item, Get a message — response body — attachments / item / type: SOCIAL MEDIA METADATA, Get a message — response body — attachments / item / type: UNSUPPORTED CONTENT, Get a message — response body — attachments / item / type: WHATSAPP TEMPLATE METADATA

Get a message — response body — attachments / item / fileUsageType: 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 specifying the usage type of the file, which can be 'STICKER', 'VOICE_RECORDING', 'IMAGE', 'AUDIO', or 'OTHER'. Known values: AUDIO, IMAGE, OTHER, STICKER, VOICE_RECORDING
name	string	Optional	A string containing the name of the file.
type	string	Required within parent	A string indicating the type of the attachment, which is always 'FILE'. Known values: FILE Default: FILE
url	string	Optional	A string containing the URL where the file can be accessed.

Get a message — response body — attachments / item / type: CONTACT

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

Referenced models: Get a message — response body — attachments / item / type: CONTACT contact Profile

Get a message — response body — 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 details such as type (e.g., HOME, WORK), street, city, state, zip, country, and country code.
addresses[]	Model	Each item	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile addresses item
emails	array	Required within parent	An array of email addresses for the contact, with each email having a type (e.g., HOME, WORK) and the email address itself.
emails[]	Model	Each item	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile emails item
name	Model	Optional	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile name
org	Model	Optional	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile org
phones	array	Required within parent	An array of phone numbers for the contact, with each phone number including a type (e.g., CELL, MAIN, HOME, WORK) and the phone number.
phones[]	Model	Each item	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile phones item
urls	array	Required within parent	An array of URLs related to the contact, where each URL includes a type (e.g., HOME, WORK) and the URL itself.
urls[]	Model	Each item	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile urls item

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

Get a message — response body — 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 value.
country	string	Optional	The country where the contact is located. It is a string value.
countryCode	string	Optional	The code representing the country of the contact's address. It is a string value.
state	string	Optional	The state where the contact is located. It is a string value.
street	string	Optional	The street address of the contact. It is a string value.
type	string	Optional	The type of address, which can be either 'HOME' or 'WORK'. Known values: HOME, WORK
zip	string	Optional	The postal code of the contact's address. It is a string value.

Get a message — response body — attachments / item / type: CONTACT contact Profile emails item

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

Get a message — response body — 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	A string representing the middle name of the contact.
prefix	string	Optional	A string representing the prefix of the contact's name, such as 'Mr.', 'Ms.', or 'Dr.'.
suffix	string	Optional	A string representing the suffix of the contact's name, such as 'Jr.', 'Sr.', or 'III'.

Get a message — response body — 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. It is a string value.
department	string	Optional	The department within the company where the contact works. It is a string value.
title	string	Optional	The job title of the contact within their company. It is a string value.

Get a message — response body — 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 string representing the contact's phone number.
type	string	Optional	The type of phone, which can be one of the following: 'CELL', 'MAIN', 'HOME', or 'WORK'. Known values: CELL, HOME, MAIN, WORK

Get a message — response body — attachments / item / type: CONTACT contact Profile urls item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Optional	The category of the URL, indicating its purpose. Valid values include 'HOME' and 'WORK'. Known values: HOME, WORK
url	string	Required within parent	The actual URL string associated with the contact.

Get a message — response body — attachments / item / type: LOCATION

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	A string representing the address of the location.
latitude	JSON	Required within parent
latitude (anyOf 1)	number	Alternative	A number representing 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 representing 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 that specifies the type of the component, which is 'LOCATION'. Known values: LOCATION Default: LOCATION
url	string	Optional	A string representing a URL associated with the location.

Get a message — response body — 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 an associated file, 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 message header. The default and only valid value is 'MESSAGE_HEADER'. Known values: MESSAGE_HEADER Default: MESSAGE_HEADER

Get a message — response body — attachments / item / type: QUICK REPLIES

Field	Type	Presence	Description and constraints
$	object	Root
allowMultiSelect	boolean	Required within parent	A boolean indicating whether multiple quick replies can be selected by the user.
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 Get a message — response body — 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'. Known values: QUICK_REPLIES Default: QUICK_REPLIES

Referenced models: Get a message — response body — attachments / item / type: QUICK REPLIES quick Replies item

Get a message — response body — attachments / item / type: QUICK REPLIES quick Replies item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional	The label displayed to the user for the quick reply option. It is a string.
value	string	Required within parent	The value associated with the quick reply, typically used as the response when the quick reply is selected. It is a string.
valueType	string	Required within parent	The type of the value, indicating how the value should be interpreted. It is a string and can be either 'TEXT' or 'URL'. Known values: TEXT, URL

Get a message — response body — attachments / item / type: SOCIAL MEDIA METADATA

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

Referenced models: Get a message — response body — attachments / item / type: SOCIAL MEDIA METADATA social Metadata

Get a message — response body — 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	The unique identifier for this media content.
mediaTitle	string	Optional	The title of the media content.
mediaType	string	Required within parent	The type of media content, such as 'PHOTO', 'VIDEO', 'CAROUSEL', 'LINK', 'ARTICLE', 'GIF', 'DOCUMENT', 'POLL', 'NONE', 'STORY', or 'AUDIO'. Known values: ARTICLE, AUDIO, CAROUSEL, DOCUMENT, GIF, LINK, NONE, PHOTO, POLL, STORY, VIDEO
mediaUrl	string	Optional	The URL where the media content is located.
mediaUrlString	string	Optional	A string representing the URL of the media content.
thumbnailUrl	string	Optional	The URL of the thumbnail image for the media content.

Get a message — response body — attachments / item / type: UNSUPPORTED CONTENT

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string that specifies the type of unsupported content. The default and only valid value is 'UNSUPPORTED_CONTENT'. Known values: UNSUPPORTED_CONTENT Default: UNSUPPORTED_CONTENT

Get a message — response body — 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 content ID 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 mapping CRM object types 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 of parameters used for template customization, where each value is a string. Additional keys: see wildcard field
parameters.*	string	Additional keys
rootMicId	JSON	Optional
rootMicId (anyOf 1)	integer	Alternative	An integer representing the root message interaction context ID. 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 indicating the type of metadata, which is 'WHATSAPP_TEMPLATE_METADATA'. Known values: WHATSAPP_TEMPLATE_METADATA Default: WHATSAPP_TEMPLATE_METADATA

Get a message — response body — 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	The unique identifier for the integration application associated with this client. It is an integer value. Format: int32
integrationAppId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a message — response body — recipients item

Field	Type	Presence	Description and constraints
$	object	Root
actorId	string	Optional	A string representing the unique identifier of the actor associated with the recipient.
deliveryIdentifier	Model	Required within parent	Expand Create a channel account — response body — delivery Identifier
name	string	Optional	A string representing the name of the recipient.
recipientField	string	Optional	A string representing a specific field related to the recipient.

Referenced models: Create a channel account — response body — delivery Identifier

Get a message — response body — 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 Create a 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, its specific use is not detailed in the spec.

Referenced models: Create a channel account — response body — delivery Identifier

Get a message — response body — status

Field	Type	Presence	Description and constraints
$	object	Root
failureDetails	Model	Optional	Expand Get a message — response body — status failure Details
statusType	string	Required within parent	The current status of the message. Valid values include 'SENT', 'FAILED', 'RECEIVED', and 'READ'. Known values: FAILED, READ, RECEIVED, SENT

Referenced models: Get a message — response body — status failure Details

Get a message — response body — status failure Details

Field	Type	Presence	Description and constraints
$	object	Root
errorMessage	string	Optional	A string containing a human-readable description of the error that occurred during message delivery.
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

Get accounts for a channel — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Get accounts for a channel — response body — paging
results	array	Required within parent	An array of PublicChannelAccount objects, each representing a public channel account with its details.
results[]	Model	Each item	Expand Create a channel account — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of public channel accounts available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get accounts for a channel — response body — paging, Create a channel account — response body

Get accounts for a channel — 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 Get all tax rates — response body — paging next
prev	Model	Optional	Expand Get accounts for a channel — response body — paging prev

Referenced models: Get all tax rates — response body — paging next, Get accounts for a channel — response body — paging prev

Get accounts for a channel — 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 indicating the position before the current page in the pagination sequence.
link	string	Optional	A URL string that can be used to access the previous page of results.

Publish a message — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
associateWithContactId	integer	Optional	The ID of the contact with which this message should be associated. Format: int64
attachments	array	Required within parent	An array of attachments included with the message, which can be files, locations, contacts, or other supported types.
attachments[]	JSON	Each item
attachments[] (oneOf 1)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / fileUsageType: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE
attachments[] (oneOf 2)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: LOCATION
attachments[] (oneOf 3)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: CONTACT
attachments[] (oneOf 4)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: UNSUPPORTED CONTENT
attachments[] (oneOf 5)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: MESSAGE HEADER
attachments[] (oneOf 6)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: QUICK REPLIES
attachments[] (oneOf 7)	Model	Alternative	Expand Publish a message — request body — body / attachments / item / type: SOCIAL MEDIA METADATA
channelAccountId	string	Required within parent	The ID of the channel account through which the message is sent.
inReplyToId	string	Optional	The ID of the message this message is replying to.
integrationIdempotencyId	string	Optional	A unique identifier to ensure idempotency of the message within the integration.
integrationThreadId	string	Optional	A unique identifier for the thread within the integration.
messageDirection	string	Required within parent	The direction of the message, indicating whether it is 'INCOMING' or 'OUTGOING'. One of: INCOMING, OUTGOING
preResolvedContacts	Model	Optional	Expand Publish a message — request body — body pre Resolved Contacts
recipients	array	Required within parent	An array of participants representing the recipients of the message.
recipients[]	Model	Each item	Expand Publish a message — request body — body senders item
richText	string	Optional	The rich text content of the message, allowing for formatting.
senders	array	Required within parent	An array of participants representing the senders of the message.
senders[]	Model	Each item	Expand Publish a message — request body — body senders item
text	string	Required within parent	The plain text content of the message.
timestamp	string	Required within parent	The date and time when the message was created, in ISO 8601 format. Format: date-time

Referenced models: Publish a message — request body — body senders item, Publish a message — request body — body / attachments / item / type: CONTACT, Publish a message — request body — body / attachments / item / type: SOCIAL MEDIA METADATA, Publish a message — request body — body / attachments / item / fileUsageType: AUDIO, IMAGE, OTHER, STICKER, VOICE RECORDING, type: FILE, Publish a message — request body — body / attachments / item / type: LOCATION, Publish a message — request body — body / attachments / item / type: MESSAGE HEADER, Publish a message — request body — body pre Resolved Contacts, Publish a message — request body — body / attachments / item / type: QUICK REPLIES, Publish a message — request body — body / attachments / item / type: UNSUPPORTED CONTENT

Publish a message — request body — body / attachments / item / fileUsageType: 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	Optional	A string that specifies the usage type of the file. Valid values include 'STICKER', 'VOICE_RECORDING', 'IMAGE', 'AUDIO', and 'OTHER'. One of: AUDIO, IMAGE, OTHER, STICKER, VOICE_RECORDING
type	string	Required within parent	A string that indicates the type of attachment. The default value is 'FILE'. Default: FILE One of: FILE

Publish a message — request body — body / attachments / item / type: CONTACT

Field	Type	Presence	Description and constraints
$	object	Root
contactProfile	Model	Required within parent	Expand Publish a message — request body — body / attachments / item / type: CONTACT contact Profile
type	string	Required within parent	A string indicating the type of attachment. The default value is 'CONTACT'. Default: CONTACT One of: CONTACT

Referenced models: Publish a message — request body — body / attachments / item / type: CONTACT contact Profile

Publish a message — request body — body / 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 details such as type (e.g., HOME, WORK), street, city, state, zip, country, and country code.
addresses[]	Model	Each item	Expand Publish a message — request body — body / attachments / item / type: CONTACT contact Profile addresses item
emails	array	Required within parent	An array of email addresses for the contact, with each email having a type (e.g., HOME, WORK) and the email address itself.
emails[]	Model	Each item	Expand Publish a message — request body — body / attachments / item / type: CONTACT contact Profile emails item
name	Model	Optional	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile name
org	Model	Optional	Expand Get a message — response body — attachments / item / type: CONTACT contact Profile org
phones	array	Required within parent	An array of phone numbers for the contact, with each phone number including a type (e.g., CELL, MAIN, HOME, WORK) and the phone number.
phones[]	Model	Each item	Expand Publish a message — request body — body / attachments / item / type: CONTACT contact Profile phones item
urls	array	Required within parent	An array of URLs related to the contact, where each URL includes a type (e.g., HOME, WORK) and the URL itself.
urls[]	Model	Each item	Expand Publish a message — request body — body / attachments / item / type: CONTACT contact Profile urls item

Referenced models: Publish a message — request body — body / attachments / item / type: CONTACT contact Profile addresses item, Publish a message — request body — body / attachments / item / type: CONTACT contact Profile emails item, Get a message — response body — attachments / item / type: CONTACT contact Profile name, Get a message — response body — attachments / item / type: CONTACT contact Profile org, Publish a message — request body — body / attachments / item / type: CONTACT contact Profile phones item, Publish a message — request body — body / attachments / item / type: CONTACT contact Profile urls item

Publish a message — request body — body / 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 value.
country	string	Optional	The country where the contact is located. It is a string value.
countryCode	string	Optional	The code representing the country of the contact's address. It is a string value.
state	string	Optional	The state where the contact is located. It is a string value.
street	string	Optional	The street address of the contact. It is a string value.
type	string	Optional	The type of address, which can be either 'HOME' or 'WORK'. One of: HOME, WORK
zip	string	Optional	The postal code of the contact's address. It is a string value.

Publish a message — request body — body / attachments / item / type: CONTACT contact Profile emails item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The actual email address of the contact, represented as a string.
type	string	Optional	The type of email address, which can be either 'HOME' or 'WORK'. One of: HOME, WORK

Publish a message — request body — body / 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 string representing the contact's phone number.
type	string	Optional	The type of phone, which can be one of the following: 'CELL', 'MAIN', 'HOME', or 'WORK'. One of: CELL, HOME, MAIN, WORK

Publish a message — request body — body / attachments / item / type: CONTACT contact Profile urls item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Optional	The category of the URL, indicating its purpose. Valid values include 'HOME' and 'WORK'. One of: HOME, WORK
url	string	Required within parent	The actual URL string associated with the contact.

Publish a message — request body — body / attachments / item / type: LOCATION

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	A string representing the address of the location.
latitude	number	Required within parent	A number representing the latitude of the location.
longitude	number	Required within parent	A number representing the longitude of the location.
name	string	Optional	A string representing the name of the location.
type	string	Required within parent	A string indicating the type of attachment, which is always 'LOCATION'. Default: LOCATION One of: LOCATION
url	string	Optional	A string representing a URL associated with the location.

Publish a message — request body — body / attachments / item / type: MESSAGE HEADER

Field	Type	Presence	Description and constraints
$	object	Root
fileId	integer	Optional	An optional integer representing the ID of an associated file, formatted as an int64. Format: int64
text	string	Optional	An optional string containing text information for the message header.
type	string	Required within parent	A string representing the type of attachment, which is always 'MESSAGE_HEADER'. Default: MESSAGE_HEADER One of: MESSAGE_HEADER

Publish a message — request body — body / 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 a predefined option that a user can select.
quickReplies[]	Model	Each item	Expand Publish a message — request body — body / attachments / item / type: QUICK REPLIES quick Replies item
type	string	Required within parent	A string indicating the type of attachment. The default value is 'QUICK_REPLIES'. Default: QUICK_REPLIES One of: QUICK_REPLIES

Referenced models: Publish a message — request body — body / attachments / item / type: QUICK REPLIES quick Replies item

Publish a message — request body — body / attachments / item / type: QUICK REPLIES quick Replies item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional	The label displayed to the user for the quick reply option. It is a string.
value	string	Required within parent	The value associated with the quick reply, typically used as the response when the quick reply is selected. It is a string.
valueType	string	Required within parent	The type of the value, indicating how the value should be interpreted. It is a string and can be either 'TEXT' or 'URL'. One of: TEXT, URL

Publish a message — request body — body / attachments / item / type: SOCIAL MEDIA METADATA

Field	Type	Presence	Description and constraints
$	object	Root
socialMetadata	Model	Required within parent	Expand Publish a message — request body — body / attachments / item / type: SOCIAL MEDIA METADATA social Metadata
type	string	Required within parent	A string indicating the type of attachment, which is 'SOCIAL_MEDIA_METADATA'. Default: SOCIAL_MEDIA_METADATA One of: SOCIAL_MEDIA_METADATA

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

Publish a message — request body — body / 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	The unique identifier for this media content.
mediaTitle	string	Optional	The title of the media content.
mediaType	string	Required within parent	The type of media content, such as 'PHOTO', 'VIDEO', 'CAROUSEL', 'LINK', 'ARTICLE', 'GIF', 'DOCUMENT', 'POLL', 'NONE', 'STORY', or 'AUDIO'. One of: ARTICLE, AUDIO, CAROUSEL, DOCUMENT, GIF, LINK, NONE, PHOTO, POLL, STORY, VIDEO
mediaUrl	string	Optional	The URL where the media content is located.
mediaUrlString	string	Optional	A string representing the URL of the media content.
thumbnailUrl	string	Optional	The URL of the thumbnail image for the media content.

Publish a message — request body — body / attachments / item / type: UNSUPPORTED CONTENT

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string indicating the type of the attachment. The default value is 'UNSUPPORTED_CONTENT'. Default: UNSUPPORTED_CONTENT One of: UNSUPPORTED_CONTENT

Publish a message — request body — body pre Resolved Contacts

Field	Type	Presence	Description and constraints
$	object	Root
contacts	array	Required within parent	An array of PreResolvedContact objects. Each object contains information about a contact that has been pre-resolved, including properties that led to the match. This array is required.
contacts[]	Model	Each item	Expand Publish a message — request body — body pre Resolved Contacts contacts item

Referenced models: Publish a message — request body — body pre Resolved Contacts contacts item

Publish a message — request body — body pre Resolved Contacts contacts item

Field	Type	Presence	Description and constraints
$	object	Root
contactPropertiesLeadingToMatch	array	Required within parent	An array of strings indicating the properties that were used to match and identify the contact. Valid values include various contact attributes such as 'email', 'firstname', 'lastname', and many more.
contactPropertiesLeadingToMatch[]	string	Each item	One of: address, annualrevenue, associatedcompanyid, associatedcompanylastupdated, city, closedate, company, company_size, country, createdate, currentlyinworkflow, date_of_birth, days_to_close, degree, email, engagements_last_meeting_booked, engagements_last_meeting_booked_campaign, engagements_last_meeting_booked_medium, engagements_last_meeting_booked_source, fax, field_of_study, first_conversion_date, first_conversion_event_name, first_deal_created_date, firstname, followercount, gender, graduation_date, hs_active_contracts_arr, hs_active_contracts_mrr, hs_active_contracts_tcv, hs_additional_emails, hs_all_contact_vids, hs_analytics_average_page_views, hs_analytics_first_referrer, hs_analytics_first_timestamp, hs_analytics_first_touch_converting_campaign, hs_analytics_first_url, hs_analytics_first_visit_timestamp, hs_analytics_last_referrer, hs_analytics_last_timestamp, hs_analytics_last_touch_converting_campaign, hs_analytics_last_url, hs_analytics_last_visit_timestamp, hs_analytics_num_event_completions, hs_analytics_num_page_views, hs_analytics_num_visits, hs_analytics_revenue, hs_analytics_source, hs_analytics_source_composite_data, hs_analytics_source_data_1, hs_analytics_source_data_2, hs_associated_target_accounts, hs_avatar_filemanager_key, hs_bing_ad_clicked, hs_bing_click_id, hs_buying_role, hs_calculated_form_submissions, hs_calculated_merged_vids, hs_calculated_mobile_number, hs_calculated_phone_number, hs_calculated_phone_number_area_code, hs_calculated_phone_number_country_code, hs_calculated_phone_number_region_code, hs_chat_assistant_iql_date, hs_chat_assistant_source, hs_chat_assistant_summary, hs_chatgpt_ad_clicked, hs_chatgpt_click_id, hs_clicked_linkedin_ad, hs_consent_to_email_tracking, hs_contact_creation_legal_basis_source_instance_id, hs_contact_enrichment_opt_out, hs_contact_enrichment_opt_out_timestamp, hs_content_membership_email, hs_content_membership_email_confirmed, hs_content_membership_follow_up_enqueued_at, hs_content_membership_notes, hs_content_membership_registered_at, hs_content_membership_registration_domain_sent_to, hs_content_membership_registration_email_sent_at, hs_content_membership_status, hs_conversations_visitor_email, hs_count_is_unworked, hs_count_is_worked, hs_country_region_code, hs_created_by_conversations, hs_cross_account_data_mirroring_source_account_ids, hs_cross_account_note, hs_cross_sell_opportunity, hs_current_customer, hs_currently_enrolled_in_prospecting_agent, hs_customer_agent_lead_status, hs_data_privacy_ads_consent, hs_date_entered_customer, hs_date_entered_evangelist, hs_date_entered_lead, hs_date_entered_marketingqualifiedlead, hs_date_entered_opportunity, hs_date_entered_other, hs_date_entered_salesqualifiedlead, hs_date_entered_subscriber, hs_date_exited_customer, hs_date_exited_evangelist, hs_date_exited_lead, hs_date_exited_marketingqualifiedlead, hs_date_exited_opportunity, hs_date_exited_other, hs_date_exited_salesqualifiedlead, hs_date_exited_subscriber, hs_document_last_revisited, hs_email_bad_address, hs_email_bounce, hs_email_click, hs_email_communication_subscriptions_opted_in, hs_email_communication_subscriptions_opted_out, hs_email_customer_quarantined_reason, hs_email_delivered, hs_email_domain, hs_email_engagement_likelihood_category, hs_email_first_click_date, hs_email_first_open_date, hs_email_first_reply_date, hs_email_first_send_date, hs_email_hard_bounce_reason, hs_email_hard_bounce_reason_enum, hs_email_is_ineligible, hs_email_last_click_date, hs_email_last_email_name, hs_email_last_open_date, hs_email_last_reply_date, hs_email_last_send_date, hs_email_live_sourcing_restricted, hs_email_open, hs_email_optimal_send_day_of_week, hs_email_optimal_send_time_of_day, hs_email_optout, hs_email_optout_survey_reason, hs_email_quarantined, hs_email_quarantined_reason, hs_email_recipient_fatigue_recovery_time, hs_email_replied, hs_email_sends_since_last_engagement, hs_email_type, hs_emailconfirmationstatus, hs_employment_change_detected_date, hs_enforce_double_opt_in, hs_enriched_email_bounce_detected, hs_excluded_from_cross_account_data_mirroring, hs_facebook_ad_clicked, hs_facebook_click_id, hs_facebookid, hs_feedback_last_ces_survey_date, hs_feedback_last_ces_survey_follow_up, hs_feedback_last_ces_survey_rating, hs_feedback_last_csat_survey_date, hs_feedback_last_csat_survey_follow_up, hs_feedback_last_csat_survey_rating, hs_feedback_last_nps_follow_up, hs_feedback_last_nps_rating, hs_feedback_last_nps_rating_number, hs_feedback_last_survey_date, hs_feedback_show_nps_web_survey, hs_first_closed_order_id, hs_first_engagement_object_id, hs_first_order_closed_date, hs_first_outreach_date, hs_first_subscription_create_date, hs_full_name_or_email, hs_geohash_1, hs_geohash_2, hs_geohash_3, hs_geohash_4, hs_geohash_5, hs_geohash_6, hs_google_click_id, hs_googleplusid, hs_gps_coordinates, hs_gps_error, hs_gps_latitude, hs_gps_longitude, hs_has_active_subscription, hs_inbound_agent_inquiry_type, hs_inbound_agent_last_conversation_date, hs_inbound_agent_qualification_status, hs_inferred_language_codes, hs_intent_paid_up_to_date, hs_intent_signals_enabled, hs_ip_timezone, hs_is_contact, hs_is_enriched, hs_is_mass_marketing_activation_disallowed, hs_is_merge_revertible, hs_is_unworked, hs_job_change_detected_date, hs_journey_stage, hs_language, hs_last_metered_enrichment_timestamp, hs_last_sales_activity_date, hs_last_sales_activity_timestamp, hs_last_sales_activity_type, hs_last_sms_send_date, hs_last_sms_send_name, hs_latest_disqualified_lead_date, hs_latest_meeting_activity, hs_latest_open_lead_date, hs_latest_qualified_lead_date, hs_latest_sequence_ended_date, hs_latest_sequence_enrolled, hs_latest_sequence_enrolled_date, hs_latest_sequence_finished_date, hs_latest_sequence_unenrolled_date, hs_latest_source, hs_latest_source_composite_data, hs_latest_source_data_1, hs_latest_source_data_2, hs_latest_source_timestamp, hs_latest_subscription_create_date, hs_latitude, hs_lead_status, hs_legal_basis, hs_lifecyclestage_customer_date, hs_lifecyclestage_evangelist_date, hs_lifecyclestage_lead_date, hs_lifecyclestage_marketingqualifiedlead_date, hs_lifecyclestage_opportunity_date, hs_lifecyclestage_other_date, hs_lifecyclestage_salesqualifiedlead_date, hs_lifecyclestage_subscriber_date, hs_linkedin_ad_clicked, hs_linkedin_click_id, hs_linkedin_url, hs_linkedinid, hs_live_enrichment_deadline, hs_longitude, hs_manual_campaign_ids, hs_marketable_reason_id, hs_marketable_reason_type, hs_marketable_status, hs_marketable_until_renewal, hs_membership_has_accessed_private_content, hs_membership_last_private_content_access_date, hs_messaging_engagement_score, hs_mobile_sdk_push_tokens, hs_next_renewal_date, hs_notes_last_activity, hs_notes_next_activity, hs_notes_next_activity_type, hs_num_active_contracts, hs_num_associated_open_deals, hs_persona, hs_pinned_engagement_id, hs_pipeline, hs_predictivecontactscore, hs_predictivecontactscore_tmp, hs_predictivecontactscore_v2, hs_predictivecontactscorebucket, hs_predictivescoringtier, hs_predictivescoringtier_tmp, hs_prospecting_agent_activation_email_id, hs_prospecting_agent_activation_status, hs_prospecting_agent_actively_enrolled_count, hs_prospecting_agent_enrollment_status, hs_prospecting_agent_enrollment_status_raw, hs_prospecting_agent_last_enrolled, hs_prospecting_agent_sender, hs_prospecting_agent_total_enrolled_count, hs_quarantined_emails, hs_recent_closed_order_date, hs_reddit_ad_clicked, hs_reddit_click_id, hs_registered_member, hs_registration_method, hs_returning_to_office_detected_date, hs_role, hs_sa_first_engagement_date, hs_sa_first_engagement_descr, hs_sa_first_engagement_object_type, hs_sales_email_last_clicked, hs_sales_email_last_opened, hs_sales_email_last_replied, hs_searchable_calculated_international_mobile_number, hs_searchable_calculated_international_phone_number, hs_searchable_calculated_mobile_number, hs_searchable_calculated_phone_number, hs_seniority, hs_sequences_actively_enrolled_count, hs_sequences_enrolled_count, hs_sequences_is_enrolled, hs_sms_mobilephone_communication_subscriptions_opted_in, hs_sms_mobilephone_communication_subscriptions_opted_out, hs_sms_phone_communication_subscriptions_opted_in, hs_sms_phone_communication_subscriptions_opted_out, hs_social_facebook_clicks, hs_social_google_plus_clicks, hs_social_last_engagement, hs_social_linkedin_clicks, hs_social_num_broadcast_clicks, hs_social_twitter_clicks, hs_source_object_id, hs_source_portal_id, hs_sourced_contact_origin, hs_state_code, hs_sub_role, hs_testpurge, hs_testrollback, hs_tiktok_ad_clicked, hs_tiktok_click_id, hs_time_between_contact_creation_and_deal_close, hs_time_between_contact_creation_and_deal_creation, hs_time_in_customer, hs_time_in_evangelist, hs_time_in_lead, hs_time_in_marketingqualifiedlead, hs_time_in_opportunity, hs_time_in_other, hs_time_in_salesqualifiedlead, hs_time_in_subscriber, hs_time_to_first_engagement, hs_time_to_move_from_lead_to_customer, hs_time_to_move_from_marketingqualifiedlead_to_customer, hs_time_to_move_from_opportunity_to_customer, hs_time_to_move_from_salesqualifiedlead_to_customer, hs_time_to_move_from_subscriber_to_customer, hs_timezone, hs_twitterid, hs_user_ids_of_all_notification_recipients, hs_v2_cumulative_time_in_customer, hs_v2_cumulative_time_in_evangelist, hs_v2_cumulative_time_in_lead, hs_v2_cumulative_time_in_marketingqualifiedlead, hs_v2_cumulative_time_in_opportunity, hs_v2_cumulative_time_in_other, hs_v2_cumulative_time_in_salesqualifiedlead, hs_v2_cumulative_time_in_subscriber, hs_v2_date_entered_current_stage, hs_v2_date_entered_customer, hs_v2_date_entered_evangelist, hs_v2_date_entered_lead, hs_v2_date_entered_marketingqualifiedlead, hs_v2_date_entered_opportunity, hs_v2_date_entered_other, hs_v2_date_entered_salesqualifiedlead, hs_v2_date_entered_subscriber, hs_v2_date_exited_customer, hs_v2_date_exited_evangelist, hs_v2_date_exited_lead, hs_v2_date_exited_marketingqualifiedlead, hs_v2_date_exited_opportunity, hs_v2_date_exited_other, hs_v2_date_exited_salesqualifiedlead, hs_v2_date_exited_subscriber, hs_v2_latest_time_in_customer, hs_v2_latest_time_in_evangelist, hs_v2_latest_time_in_lead, hs_v2_latest_time_in_marketingqualifiedlead, hs_v2_latest_time_in_opportunity, hs_v2_latest_time_in_other, hs_v2_latest_time_in_salesqualifiedlead, hs_v2_latest_time_in_subscriber, hs_v2_time_in_current_stage, hs_whatsapp_bsuids, hs_whatsapp_communication_subscriptions_opted_in, hs_whatsapp_communication_subscriptions_opted_out, hs_whatsapp_phone_number, hs_why_this_contact, hubspot_owner_id, hubspotscore, industry, ip_city, ip_country, ip_country_code, ip_latlon, ip_state, ip_state_code, ip_zipcode, job_function, jobtitle, kloutscoregeneral, lastmodifieddate, lastname, lifecyclestage, linkedinbio, linkedinconnections, marital_status, message, military_status, mobilephone, notes_last_contacted, notes_last_updated, notes_next_activity_date, num_associated_deals, num_contacted_notes, num_conversion_events, num_notes, num_unique_conversion_events, numemployees, owneremail, ownername, phone, photo, recent_conversion_date, recent_conversion_event_name, recent_deal_amount, recent_deal_close_date, relationship_status, salutation, school, seniority, start_date, state, surveymonkeyeventlastupdated, total_revenue, twitterbio, twitterhandle, twitterprofilephoto, webinareventlastupdated, website, work_email, zip
contactVid	integer	Required within parent	The unique identifier for the contact, represented as an integer in int64 format. Format: int64

Publish a message — request body — body senders item

Field	Type	Presence	Description and constraints
$	object	Root
deliveryIdentifier	Model	Required within parent	Expand Create a channel account — request body — body delivery Identifier
name	string	Optional	The name of the participant. It is a string that can be used to identify the participant within the channel.
senderActorId	string	Optional	A string representing the unique identifier of the sender actor. This is used to distinguish the sender within the channel integration.

Referenced models: Create a channel account — request body — body delivery Identifier

Update a channel account staging token — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountName	string	Optional	A string representing the name of the account associated with the staging token.
deliveryIdentifier	Model	Optional	Expand Create a channel account — request body — body delivery Identifier

Referenced models: Create a channel account — request body — body delivery Identifier

Update a channel account staging token — response body

Field	Type	Presence	Description and constraints
$	object	Root
accountName	string	Optional	A string representing the name of the account.
accountToken	string	Required within parent	A string representing the unique token for the account.
createdAt	string	Required within parent	The date and time when the token was created, in ISO 8601 format. Format: date-time
deliveryIdentifier	Model	Optional	Expand Create a channel account — response body — delivery Identifier
genericChannelId	JSON	Required within parent
genericChannelId (anyOf 1)	integer	Alternative	An integer representing the unique identifier of the generic channel. Format: int32
genericChannelId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inboxId	JSON	Required within parent
inboxId (anyOf 1)	integer	Alternative	An integer representing the unique identifier of the inbox associated with the account. Format: int32
inboxId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userId	JSON	Required within parent
userId (anyOf 1)	integer	Alternative	An integer representing the unique identifier of the user associated with the account. Format: int32
userId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a channel account — response body — delivery Identifier

Update a channel account — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
authorized	boolean	Optional	A boolean indicating whether the channel account is authorized.
name	string	Optional	A string representing the name of the channel account.

Update a message — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
errorMessage	string	Optional	A string containing an error message, if applicable.
statusType	string	Required within parent	Valid status are SENT, FAILED, and READ One of: FAILED, READ, SENT