SupDesk
POST/v1/messages

Create a message thread

Creates a message thread using the supplied contact details and message information. Provide email in a valid email address format; subject, body, name, and locale can also be included. The response contains the created thread.

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

5 body fields

Contact details and optional content for the new message thread.

subjectstringoptional
The subject of the message thread.
bodystringoptional
The message content for the thread.
emailstringrequired
The contact email address, in a valid email address format.
namestringoptional
The contact name.
localestringoptional
The locale associated with the thread.

2 status codes
201Returns the created thread in the `data` object.
dataobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. email is required and must use a valid email address format.