Reference
Messaging
Send, edit, delete and react to messages, and upload the media they carry
Everything here needs MESSAGES_SEND. The narrative version is in Messaging.
addMessageReaction
Mutation
ScopeMESSAGES_SEND
Add an emoji reaction to a message (idempotent; replaces your previous reaction).
Arguments
messageIdString!RequiredemojiString!RequiredReturns
_idString!messageIdFloatexternalMessageIdStringtypeMessageType!fromMessageSenderUnionchatChat!directionMessageDirection!sentFromChannelBooleantextStringmediaGroup[MediaGroupMessage!]media[Media!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleancontactContactlocationMessageLocationunsupportedMessageUnsupportedproducts[MessageProduct!]pollMessagePolldiceMessageDicegameMessageGamebuttons[MessageButton!]sources[MessageSource!]replyToMessageMessagemutation {
addMessageReaction(messageId: "…", emoji: "…") { _id messageId externalMessageId type from }
}createMedia
Mutation
ScopeMESSAGES_SEND
Arguments
fileUpload!RequiredCreateMediaInput
typeString!RequiredfilenameStringfileIdStringfileUniqueIdStringcaptionStringhasSpoilerBooleanwidthFloatheightFloatfileSizeFloatdurationFloatsupportsStreamingBooleandisableContentTypeDetectionBooleanperformerStringtitleStringmimeTypeStringthumbnailThumbnailInputisAnimatedBooleanisVideoBooleanemojiStringsetNameStringcustomEmojiIdStringstickerTypeStringReturns
_idString!urlString!typeMediaType!filenameStringwidthFloatheightFloatfileSizeFloatdurationFloatsupportsStreamingBooleandisableContentTypeDetectionBooleanperformerStringtitleStringmimeTypeStringthumbnailThumbnailframes[Thumbnail!]isAnimatedBooleanisVideoBooleanemojiStringsetNameStringcustomEmojiIdStringstickerTypeStringneedsRepaintingBooleanprocessedContentStringProcessed/extracted text content for knowledge base
isProcessedBooleanWhether file processing is complete for knowledge base
mutation {
createMedia(createMediaInput: { … }, file: { … }) { _id url type filename width }
}deleteMedia
Mutation
ScopeMESSAGES_SEND
Arguments
idString!RequiredReturns
Boolean!mutation {
deleteMedia(id: "…")
}deleteMessage
Mutation
ScopeMESSAGES_SEND
Arguments
messageIdString!RequiredReturns
Boolean!mutation {
deleteMessage(messageId: "…")
}removeMessageReaction
Mutation
ScopeMESSAGES_SEND
Remove your emoji reaction from a message (idempotent no-op if absent).
Arguments
messageIdString!RequiredemojiString!RequiredReturns
_idString!messageIdFloatexternalMessageIdStringtypeMessageType!fromMessageSenderUnionchatChat!directionMessageDirection!sentFromChannelBooleantextStringmediaGroup[MediaGroupMessage!]media[Media!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleancontactContactlocationMessageLocationunsupportedMessageUnsupportedproducts[MessageProduct!]pollMessagePolldiceMessageDicegameMessageGamebuttons[MessageButton!]sources[MessageSource!]replyToMessageMessagemutation {
removeMessageReaction(messageId: "…", emoji: "…") { _id messageId externalMessageId type from }
}retryFailedMessage
Mutation
ScopeMESSAGES_SEND
Retry sending a failed message. Only messages with deliveryStatus "failed" can be retried.
Arguments
messageIdString!RequiredReturns
_idString!messageIdFloatexternalMessageIdStringtypeMessageType!fromMessageSenderUnionchatChat!directionMessageDirection!sentFromChannelBooleantextStringmediaGroup[MediaGroupMessage!]media[Media!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleancontactContactlocationMessageLocationunsupportedMessageUnsupportedproducts[MessageProduct!]pollMessagePolldiceMessageDicegameMessageGamebuttons[MessageButton!]sources[MessageSource!]replyToMessageMessagemutation {
retryFailedMessage(messageId: "…") { _id messageId externalMessageId type from }
}sendMessage
Mutation
ScopeMESSAGES_SEND
Arguments
CreateCombinedMessageInput
createdAtDateTimedeliveryStatusMessageDeliveryStatusDelivery status - defaults based on message direction
replyToMessageStringmentions[ID!]internalBooleanPost as an internal note without a mention (team-only, never sent to the customer).
textStringbuttons[MessageButtonInput!]replyToButtonIdStringkeyboardTypeStringflowTitleStringmedia[String!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleanmediaGroupIdStringisMediaGroupBooleanmediaGroup[String!]Returns
_idString!messageIdFloatexternalMessageIdStringtypeMessageType!fromMessageSenderUnionchatChat!directionMessageDirection!sentFromChannelBooleantextStringmediaGroup[MediaGroupMessage!]media[Media!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleancontactContactlocationMessageLocationunsupportedMessageUnsupportedproducts[MessageProduct!]pollMessagePolldiceMessageDicegameMessageGamebuttons[MessageButton!]sources[MessageSource!]replyToMessageMessagemutation {
sendMessage(chatId: "…", input: { … }, actingUserId: "…", async: false) { _id messageId externalMessageId type from }
}sendWhatsAppTemplateMessage
Mutation
ScopeMESSAGES_SEND
Send a WhatsApp template message to a chat (works anytime, even outside 24h window)
Arguments
SendWhatsAppTemplateInput
templateIdString!RequiredTemplate ID to send
chatIdString!RequiredChat ID to send the template to
variableOverridesTemplateVariableOverridesManual variable values to override auto-resolved values
productOverridesProductTemplateOverridesProduct-specific overrides for SPM, MPM, and Product Card Carousel templates. Required for catalog-based templates.
Returns
successBoolean!messageIdStringWhatsApp message ID if successful
errorStringmutation {
sendWhatsAppTemplateMessage(input: { … }) { success messageId error }
}updateMessage
Mutation
ScopeMESSAGES_SEND
Arguments
messageIdString!RequiredUpdateMessageInput
messageIdStringupdatedAtDateTimetextStringcaptionStringCaption for media messages
reactionMessageReactionInputresolvedBooleanmentions[ID!]Returns
_idString!messageIdFloatexternalMessageIdStringtypeMessageType!fromMessageSenderUnionchatChat!directionMessageDirection!sentFromChannelBooleantextStringmediaGroup[MediaGroupMessage!]media[Media!]captionStringshowCaptionAboveMediaBooleanhasMediaSpoilerBooleancontactContactlocationMessageLocationunsupportedMessageUnsupportedproducts[MessageProduct!]pollMessagePolldiceMessageDicegameMessageGamebuttons[MessageButton!]sources[MessageSource!]replyToMessageMessagemutation {
updateMessage(messageId: "…", input: { … }) { _id messageId externalMessageId type from }
}uploadMultipleMedia
Mutation
ScopeMESSAGES_SEND
Arguments
files[Upload!]!RequiredCreateMediaInput
typeString!RequiredfilenameStringfileIdStringfileUniqueIdStringcaptionStringhasSpoilerBooleanwidthFloatheightFloatfileSizeFloatdurationFloatsupportsStreamingBooleandisableContentTypeDetectionBooleanperformerStringtitleStringmimeTypeStringthumbnailThumbnailInputisAnimatedBooleanisVideoBooleanemojiStringsetNameStringcustomEmojiIdStringstickerTypeStringReturns
_idString!urlString!typeMediaType!filenameStringwidthFloatheightFloatfileSizeFloatdurationFloatsupportsStreamingBooleandisableContentTypeDetectionBooleanperformerStringtitleStringmimeTypeStringthumbnailThumbnailframes[Thumbnail!]isAnimatedBooleanisVideoBooleanemojiStringsetNameStringcustomEmojiIdStringstickerTypeStringneedsRepaintingBooleanprocessedContentStringProcessed/extracted text content for knowledge base
isProcessedBooleanWhether file processing is complete for knowledge base
mutation {
uploadMultipleMedia(files: […], createMediaInputs: […]) { _id url type filename width }
}