Import message

post https://api2.frontapp.com/inboxes/{inbox_id}/imported_messages

Import a new message in an inbox. Only use this endpoint to import historical, non-active conversations. Do not use it to create messages for new conversations.

Path Params

inbox_id

string

required

Defaults to inb_123

The Inbox ID

Body Params

sender

object

required

Data of the sender

array of strings

required

List of the recipient handles who will receive this message

to*

array of strings

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

bcc

array of strings

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

bcc

subject

string

Subject of the message

body

string

required

Body of the message

body_format

string

Defaults to markdown

Format of the message body. Can be markdown (default) or html, and can only be specified for email type.

external_id

string

required

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

created_at

integer

required

Date at which the message as been sent or received.

type

string

Defaults to email

Type of the message to import. Default is email.

assignee_id

string

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

tags

conversation_id

string

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

metadata

object

required

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

Response

Language

Credentials

Bearer

JWT


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://api2.frontapp.com/inboxes/inb_123/imported_messages \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "body_format": "markdown",
8
  "type": "email",
9
  "metadata": {
10
    "is_inbound": true,
11
    "is_archived": true,
12
    "should_skip_rules": true
13
  }
14
}
15
'

Choose an example:

application/json

202An accepted response acknowledging your request to create a message