Menu

Expand
Rate this page:

Single Sends

A Single Send is a one-time nonautomated email message delivered to a list or segment of your audience. A Single Send may be sent immediately or scheduled for future delivery.

Single Sends can serve many use cases, including promotional offers, engagement campaigns, newsletters, announcements, legal notices, or policy updates.

The Single Sends API allows you to create, retrieve, update, delete, schedule, and deliver your Single Sends. There are also endpoints for searching and statistics to help you maintain and alter your Single Sends as you learn more and further develop your campaigns.

The Single Sends API changed on May 6, 2020. Please check the SendGrid Knowledge Center for updates and instructions here: https://sendgrid.com/docs/for-developers/sending-email/single-sends-2020-update/

Delete Single Send Schedule

DELETE /v3/marketing/singlesends/{id}/schedule

Base url: https://api.sendgrid.com

This endpoint allows you to cancel a scheduled Single Send using a Single Send ID.

Making a DELETE request to this endpoint will cancel the scheduled sending of a Single Send. The request will not delete the Single Send itself. Deleting a Single Send can be done by passing a DELETE request to /marketing/singlesends/{id}.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

id
string

The ID of the Event Webhook you want to retrieve.

default: None
required

Responses

object
send_at
string

The ISO 8601 time at which to send the Single Send. This must be in future or the string now. SendGrid Mail Send emails can be scheduled up to 72 hours in advance. However, this scheduling constraint does not apply to emails sent via Marketing Campaigns.

format: date-time
required
status
string
Allowed Values: draft, scheduled, triggered
object
errors
array[object]
field
string
message
string
error_id
string
object
errors
array[object]
field
string
message
string
error_id
string
Loading Code Sample...
        
        

        Delete Single Send Schedule

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif