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/
Create Single Send
POST /v3/marketing/singlesends
Base url: https://api.sendgrid.com
This endpoint allows you to create a new Single Send.
Please note that if you are migrating from the previous version of Single Sends, you no longer need to pass a template ID with your request to this endpoint. Instead, you will pass all template data in the email_config object.
This endpoint will create a draft of the Single Send but will not send it or schedule it to be sent. Any send_at property value set with this endpoint will prepopulate the Single Send's send date. However, the Single Send will remain an unscheduled draft until it's updated with the Schedule Single Send endpoint or SendGrid application UI.
Authentication
- API Key
Headers
Request Body
The name of the Single Send.
maxLength: 100minLength: 1The categories to associate with this Single Send.
maxItems: 10uniqueItems: TrueSet this property to an ISO 8601 formatted date-time when you would like to send the Single Send. Please note that any send_at property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the Schedule Single Send endpoint or SendGrid application UI. Additionally, the now keyword is a valid send_at value only when using the Schedule Single Send endpoint. Setting this property to now with this endpoint will cause an error.
The recipient List IDs that will receive the Single Send.
maxItems: 10The recipient Segment IDs that will receive the Single Send.
maxItems: 10Set to true to send to All Contacts. If set to false, at least one list_ids or segment_ids value must be provided before the Single Send is scheduled to be sent to recipients.
The subject line of the Single Send. Do not include this field when using a design_id.
The HTML content of the Single Send. Do not include this field when using a design_id.
The plain text content of the Single Send. Do not include this field when using a design_id.
If set to true, plain_content is always generated from html_content. If set to false, plain_content is not altered.
A design_id can be used in place of html_content, plain_content, and/or subject. You can retrieve a design's ID from the "List Designs" endpoint or by pulling it from the design's detail page URL in the Marketing Campaigns App.
The editor — "design" or "code" — used to modify the Single Send's design in the Marketing Campaigns App.
The ID of the Suppression Group to allow recipients to unsubscribe — you must provide this or the custom_unsubscribe_url.
The URL allowing recipients to unsubscribe — you must provide this or the suppression_group_id.
The ID of the verified Sender. You can retrieve a verified Sender's ID from the "Get Verified Senders" endpoint or by pulling it from the Sender's detail page URL in the SendGrid App.
The name of the IP Pool from which the Single Send emails are sent.
Responses
The unique ID for the Single Send.
format: uuidThe name of the Single Send.
maxLength: 100minLength: 1The current status of the Single Send. The status may be draft, scheduled, or triggered.
The categories associated with this Single Send.
maxItems: 10uniqueItems: TrueAn ISO 8601 formatted date-time when the Single Send is set to be sent. Please note that any send_at property value will have no effect while the Single Send status is draft. You must update the Single Send with the Schedule Single Send endpoint or SendGrid application UI to schedule it.
The IDs of each contact list to which the Single Send will be sent.
maxItems: 10The IDs of each segment to which the Single Send will be sent.
maxItems: 10If this property is set to true, the Single Send will be sent to all of your contacts. If it's set to false, at least one list_ids or segment_ids value must be provided before the Single Send is scheduled to be sent.
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-timeThe subject line of the Single Send. This property is not used when a design_id value is set.
The HTML content of the Single Send. This property is not used when a design_id value is set.
The plain text content of the Single Send. This property is not used when a design_id value is set.
If this property is set to true, plain_content is always generated from html_content. If it's set to false, plain_content is not altered.
A design_id can be used in place of html_content, plain_content, and/or subject. You can retrieve a design's ID from the List Designs endpoint or by pulling it from the design's detail page URL in the Marketing Campaigns App.
The editor, design or code, used to modify the Single Send's design in the Marketing Campaigns application user interface.
The ID of the Suppression Group to allow recipients to unsubscribe. You must provide a suppression_group_id or the custom_unsubscribe_url with your Single Send.
The URL allowing recipients to unsubscribe. You must provide a custom_unsubscribe_url or a suppression_group_id with your Single Send.
The ID of the verified sender from whom the Single Send will be sent. You can retrieve a verified sender's ID from the Get Verified Senders endpoint or by pulling it from the sender's detail page URL in the SendGrid App.
The name of the IP Pool from which the Single Send emails are sent.
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.
