provider Messages POST /inboxes/{inbox_id}/imported_messages
@utdk/front /inboxes/{inbox_id}/imported_messages
Import message
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](https://dev.frontapp.com/reference/create-message) endpoint to send (rather than import) a new message. Required scope: `messages:write`
inbox_id path required
The Inbox ID
string

Try it

Authentication
Configure credentials for Core API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

importInboxMessage
POST/inboxes/{inbox_id}/imported_messages
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](https://dev.frontapp.com/reference/create-message) endpoint to send (rather than import) a new message. Required scope: `messages:write`

Parameters

required

The Inbox ID

Input

required

Data of the sender

required

List of the recipient handles who will receive this message

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

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

Subject of the message

required

Body of the message

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

required

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

required

Date at which the message as been sent or received.

Type of the message to import. Default is `email`.

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

List of tag names to add to the conversation

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

required

Binary data of attached files. Must use `Content-Type: multipart/form-data` if specified. See [example](https://gist.github.com/hdornier/e04d04921032e98271f46ff8a539a4cb) or read more about [Attachments](https://dev.frontapp.com/docs/attachments-1). Max 25 MB.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import front from '@utdk/front';

await front.importInboxMessage({
  "inbox_id": "inb_123",
  "body_format": "markdown",
  "type": "email"
})