Create draft

post https://api2.frontapp.com/channels/{channel_id}/drafts

Create a draft message which is the first message of a new conversation.

Path Params

channel_id

string

required

Defaults to cha_123

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

Body Params

author_id

string

ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a resource alias. If omitted, will post as the API Token or Application making the request.

array of strings

List of recipient handles who will receive the message once the draft is sent

array of strings

List of recipient handles who will receive a copy of the message once the draft is sent

bcc

array of strings

List of the recipient handles who will receive a blind copy of the message once the draft is sent

bcc

subject

string

Subject of the draft.

body

string

required

Body of the draft

quote_body

string

Body for the quote that the message is referencing. Only available on email channels.

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

mode

string

Defaults to private

Mode of the draft to create. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation).

signature_id

string

ID of the signature to attach to this draft. If null, no signature is attached.

should_add_default_signature

boolean

Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false;

Response

Response body

object

_links

object

self

string

Link to resource

object

string

Unique identifier of the message

type

string

Type of the message

call custom email facebook front_chat googleplay intercom internal phone-call sms tweet tweet_dm whatsapp yalo_wha

is_inbound

boolean

Whether or not the message has been received or sent

draft_mode

string | null

If the message is a draft, describes the draft mode. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation).

shared private

error_type

string

Type of the error when the draft failed to be sent

version

string

The current version of the message in Front

created_at

number

Date at which the message as been sent or received

subject

string

Subject of the message

blurb

string

Preview of the message body

author

object

Front teammate who sent this message

_links

object

string

Unique identifier of the teammate

string

Email address of the teammate

username

string

Username of the teammate (used for "@" mentions)

first_name

string

First name of the teammate

last_name

string

Last name of the teammate

is_admin

boolean

Whether or not the teammate is an admin in your company

is_available

boolean

Whether or not the teammate is available

is_blocked

boolean

Whether or not the teammate account has been blocked

type

string

Type of the teammate, normal teammates are denoted as "user", while visitors are denoted as "visitor".
Bot users are denoted by their parent resource type.
The following bot types are available:

rule: acting on behalf of a Rule, author of comments and drafts
macro: acting on behalf of a Macro, author of comments and drafts
API: acting on behalf of OAuth clients
integration: acting on behalf of an Integration
CSAT: used for authoring CSAT response comments

user visitor rule macro API integration CSAT

custom_fields

object

Custom fields for this teammate

Has additional fields

recipients

array of objects

recipients

object

_links

object

name

string

Name of the recipient.

handle

string

Handle of the contact. Can be any string used to uniquely identify the contact

role

string

Role of the recipient

from to cc bcc

body

string

Body of the message

text

string

Text version of the body for email messages

attachments

array of objects

List of files attached to the message

attachments

object

string

The unique identifier of the attachment.

filename

string

Name of the attached file

url

string

URL to download the attached file

content_type

string

Content type of the attached file in MIME format. Note that some attachments types may not be supported.

size

integer

Size (in byte) of the attached file

metadata

object

Attachment metadata

signature

object

The signature attached to this message

_links

object

string

Unique identifier of the signature

name

string

Name of the signature

body

string

Body of the signature

sender_info

string

Sender info of the signature

is_visible_for_all_teammate_channels

boolean

Whether or not the signature is available in teammate channels.

is_default

boolean

Whether the signature is the default signature for the team or teammate.

is_private

boolean

Whether the signature is private to the teammate.

channel_ids

array of strings

channel_ids

metadata

object

Optional metadata about the message

intercom_url

string

For intercom messages only. URL of the Intercom conversation the message is coming from.

duration

integer

For truly-call messages only. Length of the call in seconds.

have_been_answered

boolean

For truly-call messages only. Whether or not the call have been answered.

external_id

string

For tweet or 'custom' (partner channel token authenticated) messages only. Unique message identifier in the underlying provider (Twitter or Partner). For custom messages, only present for partner channel token authenticated requests.

twitter_url

string

For tweet messages only. URL of the tweet.

is_retweet

boolean

For tweet messages only. Whether or not the tweet is a retweet.

have_been_retweeted

boolean

For tweet messages only. Whether or not the tweet have been retweeted.

have_been_favorited

boolean

For tweet messages only. Whether or not the tweet have been favorited.

thread_ref

string

For custom messages only. Custom reference which is used to thread messages.

headers

object

For custom messages only. Custom object holding internal information.

Has additional fields

chat_visitor_url

string

For front_chat messages only. Source URL from the chat widget when sending a message.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api2.frontapp.com/channels/cha_123/drafts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"mode":"private"}'

Choose an example:

application/json

200A message