Create a Draft - Drafts - API Reference

POST

https://api.us.nylas.com/v3/grants/{grant_id}/drafts

Creates a draft.

If you provide tracking_options.domain_name, Nylas validates the custom hostname and stores its canonical value with the draft's link click and message open tracking settings. If you omit the field, Nylas uses its regional tracking hostname when it creates tracking URLs.

NYLAS API KEYACCESS TOKEN

Parameters

Path parameters

grant_id*string

ID of the grant to access. Use /me/ to refer to the grant associated with an access token.

Request body

Content-Type: application/json, multipart/form-data

bccarray<object>

The name/email address pairs of the recipients to be BCC'd.

Example: [{"email":"[email protected]","name":""}]

bodystring

The body of the draft, in HTML format.

Example: "Hi, Welcome to Nylas!"

ccarray<object>

The name/email address pairs of the recipients to be CC'd.

Example: [{"email":"[email protected]","name":""}]

tracking_optionsobject

attachmentsarray<object>

An array of file attachments to include in the draft. You can use either the application/json or multipart/form-data schema, depending on the size of the attachment.

The application/json schema is limited to 3MB, including the message body. The content must be Base64-encoded.

The multipart/form-data schema is limited by the provider to 25MB. See the Attachments references for more information.

fromarray<object>

An array that contains a single name and email address pair that Nylas sets as the from header. By default, Nylas uses the email address associated with the grant_id.

Nylas supports multiple from addresses for email aliases only.

Example: [{"email":"[email protected]","name":"Leyah Miller"}]

is_plaintextboolean

When true, the message body is sent as plain text and the MIME data doesn't include the HTML version of the message. When false, the message body is sent as HTML.

Default: false

reply_toarray<object>

An array of name/email address pairs that should receive replies to the message. This is used to set an alternative Reply-To header in the sent message. Not all providers support setting this in a draft.

Example: [{"email":"[email protected]","name":""}]

reply_to_message_idstring

The unique identifier of the message to which you want to draft a reply.

Example: "1t8tv3890q4vgmwq6pmdwm8qg"

starredboolean

If true, the draft is starred.

Example: false

subjectstring

The subject line of the draft.

Example: "Invitation: Welcome! @ Thu Oct 28, 2021 7am - 8am (EDT) - Toronto"

toarray<object>

The name/email address pairs of the recipients.

Example: [{"email":"[email protected]","name":""},{"email":"[email protected]","name":""}]

custom_headersarray<object>

An array of custom headers to add to the message.

metadataobject

The metadata associated with the object. For more information, see Metadata.

templateobject

The template to use for the message. Can be overriden by the body and subject fields.

signature_idstring

The ID of a signature to append to the draft body. Nylas inserts the signature after a line break at the end of the body. Only one signature can be used per draft.

Example: "sig_abc123"

Responses

request_idstring

The request ID.

dataobject

A draft of a message. You can edit a draft until you send it as a message.

bccarray<object>

The name/email address pairs of the recipients to be BCC'd.

bodystring

The body of the draft as either plain-text or HTML content. If the draft has both plain-text and HTML, Nylas returns the HTML version.

Example: "Hi, Welcome to Nylas!"

ccarray<object>

The name/email address pairs of the recipients to be CC'd.

attachmentsarray<object>

An array of Attachment objects. For Google, linked Google Drive files are not included. For Microsoft, linked One Drive files are not included.

Example:

[{"content_disposition":"attachment","content_type":"text/calendar","id":"4kj2jrcoj9ve5j9yxqz5cuv98","size":1708},{"content_disposition":"attachment","content_type":"application/ics","filename":"invite.ics","id":"70jcsv367jaiavt4njeu4xswg","size":1708}]

foldersarray<string>

A list of folder IDs. For Microsoft, only a single folder is supported. For Google, multiple folders may exist.

Example: ["8l6c4d11y1p4dm4fxj52whyr9","d9zkcr2tljpu3m4qpj7l2hbr0"]

fromarray<object>

An array containing a single name/email address pair, to set as the From header.

Example: [{"email":"[email protected]","name":""}]

grant_idstringread-only

The ID of grant for the connected user.

Example: "41009df5-bf11-4c97-aa18-b285b5f2e386"

idstring

A globally unique object identifier for Microsoft accounts. An email address for Google accounts.

Example: "5d3qmne77v32r8l4phyuksl2x, [email protected]"

minLength: 1

metadataobject

The metadata associated with the object. For more information, see Metadata.

objectstring

The object type of the response. In this case, draft.

Example: "draft"

reply_toarray<object>

An array of name/email address pairs that should receive replies to the message.

Example: [{"email":"[email protected]","name":""}]

snippetstring

A short snippet of the message body (the first 100 characters, with any HTML tags removed). This is useful for displaying a preview of a draft message.

Example:

"You have been invited to the following event. Welcome! WhenThu Oct 28, 2021 7am - 8am Eastern\nTime - Toronto Joining info"

minLength: 1

starredboolean

When true, shows that the Draft has been starred by the user. For EWS, this is only supported for Microsoft Exchange 2010 or later.

Example: false

subjectstring

The subject line of the draft.

Example: "Invitation: Welcome! @ Thu Oct 28, 2021 7am - 8am (EDT) - Toronto"

thread_idstring

A reference to the parent Thread object. If this is a new draft, the thread is empty.

Example: "1t8tv3890q4vgmwq6pmdwm8qg"

toarray<object>

The name/email address pairs of the recipients.

Example: [{"email":"[email protected]","name":""},{"email":"[email protected]","name":""}]

minItems: 1