FRfrontapp
Messages

Receive custom messages

Changed on

Receive a custom message in Front. This endpoint is available for custom channels ONLY.

Required scope: messages:write

post/channels/{channel_id}/incoming_messages

Request

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

Path parameters

channel_idstring required

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

Request body

subjectstring

Subject of the message

bodystring required

Body of the message

body_format'html' | 'markdown'

Format of the message body. Can be markdown (default) or html.

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.

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