FRfrontapp
Messages

Create message

Changed on

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

post/channels/{channel_id}/messages

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/channels/{channel_id}/messages
  • Auth
    HTTP bearer

Path parameters

channel_idstring required

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

Request body

tostring[] required

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

ccstring[]

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

bccstring[]

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

sender_namestring

Name used for the sender info of the message

subjectstring

Subject of the message for email message

author_idstring

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

bodystring required

Body of the message

textstring

Text version of the body for email messages

attachmentsstring[]

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

signature_idstring

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.

should_add_default_signatureboolean

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

An accepted response acknowledging your request to create a message

statusstring

The status of the incoming message. Should return 'accepted' if successful.

message_uidstring

Message unique identifier. Use the message UID as a resource alias to check whether the message is created successfully.

Example response

{
  "status": "accepted",
  "message_uid": "1eab543f84a0785f7b6b8967cck18f4d"
}

Changes

  • d5ddea1da69eRevision changes
    • breaking

      request body became required

    • breaking

      the / request property type changed from object to string

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property