Skip to content

BusinessChatSendMessageRequest object

FieldTypeDescription
conversationIdrequiredstringMongoDB ObjectId of the conversation
isReplyrequiredstringWhether this message is a reply. When `true`, `parentMessageProviderId` is required. When `false`, `parentMessageProviderId` must not be provided.
parentMessageProviderIdstringProvider id of the parent message when `isReply` is `true`.
referencedMessageIdstringOptional referenced message id.
contentstringText body of the message.
typestringMessage type. For media types, provide `fileUrl` or `fileId`. Location is not supported.
fileUrlstring (uri)Public HTTP(S) URL of media to download and send. Must be a direct media file (not an HTML page). Mutually exclusive with `fileId` and multipart `file`.
fileIdstringExisting file/attachment id for media messages. Mutually exclusive with `fileUrl` and multipart `file`.
virtualIdstringOptional client-generated id for correlating the outbound message.
interactiveobjectInteractive payload for WhatsApp list or Instagram quick replies. Location request payloads are not documented/supported for Developer API.
mentionsstring[]Optional array of user mention ids.
isPrivatebooleanWhen true, stores the message as a private note.
meta_dataobjectOptional arbitrary metadata.