This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Sends a message to the business or participant.
Specify the message type in message.content
by including the appropriate object: basic
, template
, minimal
, or form
.
For more information on message types
and how each type renders in Inbox and the Chat widget,
see Message Types.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the conversation to add the message to.
Message to send.
Controls whether the message triggers notifications when it's received.
Defaults to false
.
Controls whether the unread count and conversation summary are updated in the Message List.
If true
, unread count and conversation summary are not updated.
Defaults to false
.
Controls which identity to use in the message's sender
property.
CALLER
: Uses the identity included in the request header.PARTICIPANT
: Uses the anonymousVisitorId
, contactId
, or memberId
of the conversation's participant.BUSINESS_USER
: For internal use. Uses the wixUserId
of the person sending messages on behalf of the business.Defaults to CALLER
.
For 3rd-party apps, the app is the caller.
Sent message.
There is 1 error with this status code.
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.