SupDesk
POST/v1/messages/{threadId}/messages

Add a message to a thread

Adds a message to an existing message thread. Provide body and sender; sender identifies whether the message is from an end user, member, or system. Use threadId to select the thread that receives the message.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
threadIdstringrequired
The identifier of the message thread to add the message to.

The message content, sender type, and optional locale.

bodystringrequired
The content of the message.
senderstringrequired
The sender type: `end_user`, `member`, or `system`.
Allowed:end_usermembersystem
localestringoptional
The locale associated with the message.

3 status codes
201Returns the created message in the `data` object.
dataobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional
404Returned when no thread exists with the given `threadId`.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. A 404 is returned when no thread exists with the given threadId path parameter. body and sender are required, and sender must be end_user, member, or system.