FRfrontapp
Messages

Import message

Changed on

Use this endpoint to import conversations into Front without sending data through a channel. Typical use cases include importing historical conversations or creating new conversations from non-standard sources, such as web form submissions that can't use the default Form channel (for example, forms that don't have static URLs or form providers that send email notifications after submission). Avoid using this endpoint for conversations that can be handled by a dedicated Front channel—instead, use the Create message endpoint to send (rather than import) a new message.

Required scope: messages:write

post/inboxes/{inbox_id}/imported_messages

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/inboxes/{inbox_id}/imported_messages
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The Inbox ID

Request body

tostring[] required

List of the recipient handles who will receive this message

ccstring[]

List of the recipient handles who will receive a copy of this message

bccstring[]

List of the recipient handles who will receive a blind copy of this message

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, and can only be specified for email type.

external_idstring required

External identifier of the message. Front won't import two messages with the same external ID.

created_atinteger required

Date at which the message as been sent or received.

type'email' | 'sms' | 'intercom' | 'custom'

Type of the message to import. Default is email.

assignee_idstring

ID of the teammate who will be assigned to the conversation.

tagsstring[]

List of tag names to add to the conversation

conversation_idstring

If supplied, Front will thread this message into conversation with the given ID. Note that including this parameter nullifies the thread_ref parameter completely.

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