# Update a draft > **PUT** `https://api.us.nylas.com/v3/grants/{grant_id}/drafts/{draft_id}` Source: https://developer.nylas.com/docs/reference/api/drafts/put-drafts-id/ Updates the specified draft. When you make a `PUT` request, Nylas replaces all data in the nested object with the information included in your request. For more information, see [Updating objects](/docs/reference/api/#updating-objects). **Authentication:** NYLAS_API_KEY, ACCESS_TOKEN ## Parameters ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `select` | string | No | Specify fields that you want Nylas to return, as a comma-separated list (for example, `select=id,updated_at`). This allows you to receive only the portion of object data that you're interested in. You can use `select` to optimize response size and reduce latency by limiting queries to only the information that you need. | ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `grant_id` | string | Yes | ID of the grant to access. Use `/me/` to refer to the grant associated with an access token. | | `draft_id` | string | Yes | ID of the draft to access. Nylas recommends you URL-encode this field, or you might receive a [`404` error](/docs/api/errors/400-response/) if the ID contains special characters (for example, `#`). | ## Request body Content-Type: application/json, multipart/form-data - `bcc` (array) - The name/email address pairs of the recipients to be BCC'd. - `name` (string) - `email` (string) **(required)** - `body` (string) - The body of the draft, in HTML format. - `cc` (array) - The name/email address pairs of the recipients to be CC'd. - `name` (string) - `email` (string) **(required)** - `attachments` (array) - An array of file attachments to include in the draft. You can use either the `application/json` or `multipart/form-data` schema, depending on attachment size. The `application/json` format is limited to 3MB including the message body, and the `content` must be Base64 encoded. The `multipart/form-data` format size is limited by the provider to 25MB. See [Attachments](/#tag--Attachments) for more information. - `filename` (string) - `content` (string) - Must be Base64-encoded if using the `application/json` schema. Use binary format if using `multipart/form-data`. - `content_type` (string) - The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) of the attachment, used by the email client to determine how to display the attachment. If you don't provide a type, Nylas infers it from the file name. - `content_id` (string) - (Inline attachments only) The alphanumeric `cid` from the `` tag in the message's HTML. For example, you might see something like `` in the message body. Only include a value for the `content_id` field if the attachment is inline. - `content_disposition` (string) - (Not supported for Microsoft and EWS) The content disposition of the attachment. Usually, this is `inline` or `attachment` followed by the file name (for example, `inline; filename="some-image.jpeg"`). - `reply_to` (array) - 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. - `name` (string) - `email` (string) **(required)** - `starred` (boolean) - If `true`, the draft is starred. - `subject` (string) - The subject line of the draft. - `to` (array) - The name/email address pairs of the recipients. - `name` (string) - `email` (string) **(required)** - `metadata` (object) - The metadata associated with the object. For more information, see [Metadata](/docs/reference/api/#metadata). - `template` (object) - The [template](/docs/reference/api/application-level-templates/) to use for the message. Can be overriden by the `body` and `subject` fields. - `id` (string) - The template ID. - `strict` (boolean) - When `true`, Nylas returns an error if the template contains variables that aren't defined in the `variables` object. - `variables` (object) - A set of key/value pairs representing variables to substitute for values in the template. ## Responses ### 200 - Draft - `request_id` (string) - The request ID. - `data` (object) - A draft of a message. You can edit a draft until you send it as a message. - `bcc` (array) - The name/email address pairs of the recipients to be BCC'd. - `name` (string) - `email` (string) **(required)** - `body` (string) - 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. - `cc` (array) - The name/email address pairs of the recipients to be CC'd. - `name` (string) - `email` (string) **(required)** - `attachments` (array) - An array of Attachment objects. For Google, linked Google Drive files are not included. For Microsoft, linked One Drive files are not included. - `id` (string) **(required)** - The ID of the attachment. - `content_type` (string) - The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) of the attachment, used by the email client to determine how to display the attachment. If you don't provide a type, Nylas infers it from the file name. The value of this field is exactly the same as the email attachment's `Content-Type` header. The provider might set additional parameters, such as `name` and `charset`. Nylas returns an empty `content_type` field if an attachment file name contains non-ASCII characters (for example, accented characters like `ΓΌ`). This is because Google can't detect its content type. - `filename` (string) - The file name of the attachment. - `grant_id` (string) - The ID of grant for the connected user. - `content_id` (string) - (Inline attachments only) The alphanumeric `cid` from the `` tag in the message's HTML. For example, you might see something like `` in the message body. Sometimes, the `content_id` value is contained in angle brackets (for example, ``). - `content_disposition` (string) - (Not supported for Microsoft and EWS) The content disposition of the attachment. Usually, this is `inline` or `attachment` followed by the file name (for example, `inline; filename="some-image.jpeg"`). - `is_inline` (boolean) - If `true`, indicates that the attachment is an inline file. - `size` (integer) - The size of the attachment, in bytes. - `folders` (array) - A list of folder IDs. For Microsoft, only a single folder is supported. For Google, multiple folders may exist. - `from` (array) - An array containing a single name/email address pair, to set as the `From` header. - `name` (string) - `email` (string) - `grant_id` (string) - The ID of grant for the connected user. - `id` (string) - A globally unique object identifier for Microsoft accounts. An email address for Google accounts. - `metadata` (object) - The metadata associated with the object. For more information, see [Metadata](/docs/reference/api/#metadata). - `object` (string) - The object type of the response. In this case, `draft`. - `reply_to` (array) - An array of name/email address pairs that should receive replies to the message. - `name` (string) - `email` (string) **(required)** - `snippet` (string) - 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. - `starred` (boolean) - When `true`, shows that the Draft has been starred by the user. For EWS, this is only supported for Microsoft Exchange 2010 or later. - `subject` (string) - The subject line of the draft. - `thread_id` (string) - A reference to the parent Thread object. If this is a new draft, the thread is empty. - `to` (array) - The name/email address pairs of the recipients. - `name` (string) - `email` (string) **(required)** ### 400 - Bad Request - `request_id` (string) - The request ID. - `error` (object) - The response error object. - `type` (string) - The error type. - `message` (string) - The error message. - `provider_error` (object) - The error from the provider. ### 401 - Unauthorized - `request_id` (string) - The request ID. - `error` (object) - The response error object. - `type` (string) - The error type. - `message` (string) - The error message. - `provider_error` (object) - The error from the provider. ### 404 - Not Found - `request_id` (string) - The request ID. - `error` (object) - The response error object. - `type` (string) - The error type. - `message` (string) - The error message. - `provider_error` (object) - The raw error from the provider, if available - `code` (string) - `message` (string) ### 429 - Rate Limit - `request_id` (string) - The request ID. - `error` (object) - The response error object. - `type` (string) - The error type. - `message` (string) - The error message. ### 504 - Provider Failure - `request_id` (string) - The request ID. - `error` (object) - The response error object. - `type` (string) - The error type. - `message` (string) - The error message. ## Code samples ### cURL ```bash curl --request PUT \ --url 'https://api.us.nylas.com/v3/grants//drafts/' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "starred": true }' ``` ### Node.js SDK ```javascript import Nylas from "nylas"; const nylas = new Nylas({ apiKey: "", apiUri: "", }); async function updateDraft() { try { const calendar = await nylas.drafts.update({ identifier: "", draftId: "", requestBody: { starred: true, }, }); console.log("Updated Draft:", calendar); } catch (error) { console.error("Error to update draft:", error); } } updateDraft(); ``` ### Python SDK ```python from nylas import Client from nylas.utils.file_utils import attach_file_request_builder nylas = Client( "", "" ) attachment = attach_file_request_builder("Nylas_Logo.png") draft = nylas.drafts.update( "", draft_id="", request_body={ "subject": "Updated Subject", "attachments": [attachment] } ) print(draft) ``` ### Ruby SDK ```ruby require 'nylas' # Initialize Nylas client nylas = Nylas::Client.new( api_key: "" ) file = Nylas::FileUtils.attach_file_request_builder("Nylas_Logo.png") request_body = { starred: true, attachments: [file] } draft, _ = nylas.drafts.update(identifier: "", draft_id: "", request_body: request_body) puts draft ``` ### Java SDK ```java import com.nylas.NylasClient; import com.nylas.models.*; public class UpdateDraft { public static void main(String[] args) throws NylasSdkTimeoutError, NylasApiError { NylasClient nylas = new NylasClient.Builder("").build(); UpdateDraftRequest requestBody = new UpdateDraftRequest. Builder(). starred(true). build(); Response draft = nylas.drafts().update("", "", requestBody); System.out.printf("%s%s%s%n", draft.getData().getId(), draft.getData().getStarred()); } } ``` ### Kotlin SDK ```kotlin import com.nylas.NylasClient import com.nylas.models.* import com.nylas.util.FileUtils fun main(args: Array) { val nylas: NylasClient = NylasClient( apiKey = "" ) val attachment: CreateAttachmentRequest = FileUtils.attachFileRequestBuilder("src/main/kotlin/Nylas_Logo.png") val requestBody = UpdateDraftRequest( attachments = listOf(attachment) ) val draft = nylas.drafts().update(identifier = "", draftId = "", requestBody = requestBody) println(draft) } ```