POST/v1/messages

Create a message thread

Creates a message thread using the supplied contact and thread details. Include email in a valid email format; you can also provide subject, body, name, and locale. A 201 response returns the created thread.

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

5 body fields

The contact and content details for the message thread.

subjectstringoptional
The subject of the message thread.
bodystringoptional
The initial message body.
emailstringrequired
The contact email address in a valid email format.
namestringoptional
The contact name.
localestringoptional
The preferred locale for the thread.

2 status codes
201Returns the created thread in the `data` field.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. email is required and must use a valid email format.