A Single Send is a one-time, non-automated 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.
Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)
This endpoint allows you to update a Single Send using a Single Send ID.
You only need to pass the properties you want to update. Any blank or missing properties will remain unaltered.
This endpoint will update 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.
The categories to associate with this Single Send.
Max items: 10
send_atstring<date-time> or null
Optional
Set 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.
Max items: 50
segment_idsarray[string<uuid>]
Optional
The recipient Segment IDs that will receive the Single Send.
Max items: 10
allboolean
Optional
Set 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.
html_contentstring
Optional
The HTML content of the Single Send. Do not include this field when using a design_id.
plain_contentstring
Optional
The plain text content of the Single Send. Do not include this field when using a design_id.
generate_plain_contentboolean
Optional
If set to true, plain_content is always generated from html_content. If set to false, plain_content is not altered.
Default: true
design_idstring
Optional
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.
editorenum<string>
Optional
The editor — "design" or "code" — used to modify the Single Send's design in the Marketing Campaigns App.
Default: codePossible values:
codedesign
suppression_group_idinteger or null
Optional
The ID of the Suppression Group to allow recipients to unsubscribe — you must provide this or the custom_unsubscribe_url.
custom_unsubscribe_urlstring<uri> or null
Optional
The URL allowing recipients to unsubscribe — you must provide this or the suppression_group_id.
sender_idinteger or null
Optional
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.
ip_poolstring or null
Optional
The name of the IP Pool from which the Single Send emails are sent.
The current status of the Single Send. The status may be draft, scheduled, or triggered.
Possible values:
draftscheduledtriggered
categoriesarray[string]
unique
Optional
The categories associated with this Single Send.
Max items: 10
send_atstring<date-time> or null
Optional
An 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.
Max items: 50
segment_idsarray[string<uuid>]
Optional
The IDs of each segment to which the Single Send will be sent.
Max items: 10
allboolean
Optional
If 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.
Default: false
updated_atstring<date-time>
Optional
the ISO 8601 time at which the Single Send was last updated.
created_atstring<date-time>
Optional
the ISO 8601 time at which the Single Send was created.
The subject line of the Single Send. This property is not used when a design_id value is set.
html_contentstring
Optional
The HTML content of the Single Send. This property is not used when a design_id value is set.
plain_contentstring
Optional
The plain text content of the Single Send. This property is not used when a design_id value is set.
generate_plain_contentboolean
Optional
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.
Default: true
design_idstring
Optional
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.
editorenum<string>
Optional
The editor, design or code, used to modify the Single Send's design in the Marketing Campaigns application user interface.
Default: codePossible values:
codedesign
suppression_group_idinteger or null
Optional
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.
custom_unsubscribe_urlstring<uri> or null
Optional
The URL allowing recipients to unsubscribe. You must provide a custom_unsubscribe_url or a suppression_group_id with your Single Send.
sender_idinteger or null
Optional
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.
ip_poolstring or null
Optional
The name of the IP Pool from which the Single Send emails are sent.