OPENAPI / COMPONENTS / SCHEMAS

SendAMessageRequest data structure

SendAMessageRequest

Request body to send a message to a channel.

object26properties
apns_bundle_idstring

apns bundle id field.

apple_critical_alert_optionsstring

apple critical alert options field.

created_atinteger

Creation timestamp.

custom_typestring

Custom type identifier.

datastring

Additional data payload.

dedup_idstring

Message deduplication ID.

filesstring

File list.

include_poll_detailsboolean

include poll details field.

is_silentboolean

Whether the message is silent.

mark_as_readboolean

Mark as read.

mention_typeSendAMessageRequestMentionTypeEnum

mentioned_user_idsarray

Mentioned user IDs.

messagestring

Error message.

message_typeSendAMessageRequestMessageTypeEnumrequired

poll_idnumber

poll id field.

push_message_templatestring

push message template field.

require_authboolean

Whether authentication is required.

send_pushboolean

send push field.

sorted_metaarrayarray

Sorted metadata array.

soundstring

sound field.

thumbnail1string

thumbnail1 field.

thumbnail2string

thumbnail2 field.

thumbnail3string

thumbnail3 field.

thumbnailsarray

thumbnails field.

user_idstringrequired

User identifier.

volumenumber

volume field.