Create Message

Create a new message or internal note in an existing ticket. A Message is a reply to the buyer and is queued for delivery to the channel; a Note is internal and never sent.

Mirakl channels and message recipients. Mirakl requires every message to name who it goes to - the customer, the marketplace operator, or both - and this API has no field for that choice. Messages created here are therefore addressed to whatever the Mirakl channel's Default messages recipients setting names, the same fallback auto replies and bulk replies already use.

Configure it in eDesk under Settings > Mailbox > Channels: edit the Mirakl channel, open its marketplace details tab (named after the marketplace, for example "Mirakl Details"), and set Default messages recipients to Customer, Operator or Customer & Operator. Prefer Customer & Operator: on a reply the setting is matched against the people already on the Mirakl thread, so a narrower value can leave a message with nobody to go to.

While the setting is left at "Not selected" a type=Message with send=true on a Mirakl ticket is rejected with error code 4024 rather than accepted and silently left undelivered. type=Note and send=false are unaffected - neither is handed to the marketplace, so neither reads the setting. Use the eDesk UI reply box when a single message needs recipients other than the channel default.

Older Mirakl channels that were connected with an API key rather than OAuth are the one exception: they send over Mirakl's legacy order-message endpoint, which always addresses the customer and has no recipient choice at all. On those channels "Default messages recipients" is not consulted, no 4024 is raised, and every message goes to the customer regardless of what the setting says.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
attachments
array of objects | null
attachments
string
required
number
required
string
boolean | null

If true (default), the response will contain the full message object

string
enum
required

Message is a reply to the buyer and is the only type that is delivered to the channel. Note is an internal note, never sent, and can be added to any ticket.

Allowed:
string
enum
Allowed:
boolean | null

If true the message item is queued for delivery to the channel. Ignored for Note, which is never sent. Delivery happens asynchronously, so a 200 here means the message was accepted and queued, not that the channel has received it. On a Mirakl ticket this is the only combination that reads the channel's "Default messages recipients" setting, and the request is refused with error code 4024 while that setting is empty.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json