Import email message

This endpoint is rate limited to 60 per minute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

The channel_id (for now only Email channels are supported). Needs access to channel

int32

ticket_id, which will be used to thread messages, otherwise contact_id will be used

string
required

The ticket status if a new ticket is created with this imported message. Either 'OPEN' or 'CLOSED'.

string
required

string (max 65000 chars) which could contain html tags. For inline attachments we request you to upload the attachments Eg: in img tag "src="DIRECT_FILE_UPLOAD.png"

string
required

Either 'INBOUND', 'OUTBOUND' or 'NOTE'

int32

The user_id, required when the message type is OUTBOUND

string
required

Unique identifier of an email message.

boolean

Either true or false

date
required

Must be in the past, ISO 8601 format e.g. 2020-01-01T10:11:12+01:00

boolean
Defaults to true

Determines if the imported message is read or unread. By default it is set to true.

string

Subject of email which could be empty

attachment
array

Array of attachment files. The number of attachments is 5 files and 20MB per request.

attachment
string
required

The email which is sending the message from that must be a valid email address.

to
array of strings

The emails which are sending the message to that must be a valid email addresses.

to
cc
array of strings

The emails which are sending the message to as CC that must be a valid email addresses.

cc
bcc
array of strings

The emails which are sending the message to as BCC that must be a valid email addresses.

bcc
boolean

When set to true and message is of type INBOUND, Journey automations with trigger Email Received will be triggered.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json