Twilio calls a one-time, non-automated email message delivered to a list or segment of your audience a Single Send. You can send such messages immediately or scheduled for future delivery. Single Sends can deliver promotional offers, engagement campaigns, newsletters, announcements, legal notices, or policy updates. The Single Sends API lets you create, retrieve, update, delete, schedule, and search for Single Sends. Another API endpoint provides campaign statistics.
The SendGrid Knowledge Center explains the latest updates to the Single Sends API.
Operation overview
GET/v3/marketing/singlesends/{id}
Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)
This endpoint allows you to retrieve details about one Single Send using a Single Send ID.
You can retrieve all of your Single Sends by making a GET request to the /marketing/singlesends endpoint.
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.