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/
Get Single Sends Search
POST /v3/marketing/singlesends/search
Base url: https://api.sendgrid.com
This endpoint allows you to search for Single Sends based on specified criteria.
You can search for Single Sends by passing a combination of values using the name, status, and categories request body fields.
For example, if you want to search for all Single Sends that are "drafts" or "scheduled" and also associated with the category "shoes," your request body may look like the example below.
{
"status": [
"draft",
"scheduled"
],
"categories": [
"shoes"
],
}
Authentication
- API Key
Headers
Request Body
leading and trailing wildcard search on name of the Single Send
maxLength: 100minLength: 1current status of the Single Send
uniqueItems: Truecategories to associate with this Single Send, match any single send that has at least one of the categories
uniqueItems: TrueQuery String
number of results to return
default: Nonetoken corresponding to a specific page of results, as provided by metadata
default: NoneResponses
name of the Single Send
maxLength: 100minLength: 1What differs between the A/B tests
Allowed Values: subject, contentHow the winner will be decided
Allowed Values: open, click, manualWhat percentage of your recipient will be included in your A/B testing
How long the A/B Testing will last
Winner of the A/B Test
When the winner was selected
Last day to select an A/B Test Winner
current status of the Single Send
Allowed Values: draft, scheduled, triggeredcategories to associate with this Single Send
maxItems: 10uniqueItems: TrueThe 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.
true if the Single Send's AB Test functionality has been toggled on
the ISO 8601 time at which the Single Send was last updated
format: date-timethe ISO 8601 time at which the Single Send was created
format: date-timeNeed 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.
