Drafts

Sends the specified draft as a message. You can optionally include a signature_id to append a signature to the message body at send time.

Queued sends on Agent Accounts

When an Agent Account sends faster than its per-second rate limit, Nylas can queue the draft instead of rejecting it, and returns 202 Accepted with the draft object. Queued drafts are sent in order, usually within seconds. A draft at the back of a full queue can take up to 90 seconds. Subscribe to message.delivered to confirm that a queued draft went out, and to message.send_failed to learn if it couldn't be sent. A draft that fails to send stays in the Drafts folder. See Send queueing.

post/v3/grants/{grant_id}/drafts/{draft_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

selectstring

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.

Request body

signature_idstring

The ID of a signature to append to the message body when sending. Nylas inserts the signature after a line break at the end of the body, including after any quoted text. Only use this if the draft was created without a signature, or if you want to add one at send time.

Example request

{
  "signature_id": "sig_abc123"
}

Response

Draft

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

    • info

      added the non-success response with the status

    • info

      added the success response with the status