Create message

Send a new message from a channel. This is one of the ways to create a new conversation. The new conversation will support both messages and comments (discussions).

Required scope: messages:send

Path Params
string
required
Defaults to cha_123

The sending channel ID. Alternatively, you can supply the sending channel address as a resource alias.

Body Params
to
array of strings
required

List of the recipient handles who will receive this message. One of to, cc, or bcc is required.

to*
cc
array of strings

List of the recipient handles who will receive a copy of this message. One of to, cc, or bcc is required.

cc
bcc
array of strings

List of the recipient handles who will receive a blind copy of this message. One of to, cc, or bcc is required.

bcc
string

Name used for the sender info of the message

string

Subject of the message for email message

string

ID of the teammate on behalf of whom the answer is sent

string
required

Body of the message

string

Text version of the body for email messages

options
object
attachments
array of files

Binary data of attached files. Must use Content-Type: multipart/form-data if specified. See example or read more about Attachments. Max 25 MB.

attachments
string

ID of the signature to attach to this draft. Only supported for email channels; using this on other channel types returns a 403 forbidden error. If null, no signature is attached.

boolean

Whether or not Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is included or if author_id is omitted. Default false.

Response

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/json