Skip to main content
POST
Create a new Message

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
id
string

Message is uniquely identified by id

agent

Message is written by Agent

lead

Lead sends/receives chat- Message

salesRep

Sales Rep sends/receives Message

internalEmail
string<idn-email>

Message is with Internal Email

externalPhoneNumber
string

Message is with External Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
externalEmail
string<idn-email>

Message is with External Email

internalPhoneNumber
string

Message is with Internal Phone Number

Pattern: ^\+?1?[- ]?\(?([0-9]{3})\)?[- ]?([0-9]{3})-?([0-9]{4})$
text
string

Message has Message Text

templateType
string

Message is autofilled by Template Type

template

Message is filled in from Template

attachments
(string | Attachment · object)[]

Message has Attachment

Response

Message Created

data
Message · object
Example:
success
boolean