Messages

Cancel a scheduled message

Cancels the send schedule for a scheduled message. You can use this endpoint up to 10 seconds before the message has reached its send_at time. If you make a DELETE request less than 10 seconds before the send_at time, Nylas cannot guarantee the schedule will be cancelled successfully.

delete/v3/grants/{grant_id}/messages/schedules/{scheduleId}

Request

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

Path parameters

scheduleIdstring required

The ID of the send schedule you want to cancel.

Response

Schedule Deleted

request_idstring required

Example response

{
  "request_id": "9c2ce8cd-d6e0-4206-a1d0-703f16880061",
  "data": {
    "message": "requested cancelation for workflow"
  }
}

Changes

No recorded changes to this operation across all 16 revisions of this API.