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 duplicate an existing Single Send using its Single Send ID.
Duplicating a Single Send is useful when you want to create a Single Send but don't want to start from scratch. Once duplicated, you can update or edit the Single Send by making a PATCH request to the /marketing/singlesends/{id} endpoint.
If you leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text “Copy of ” prepended to it. The name field length is limited to 100 characters, so the end of the new Single Send name, including “Copy of ”, will be trimmed if the name exceeds this limit.
The name of the duplicate Single Send. If you choose to leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text 'Copy of ' prepended to it. The end of the new Single Send name, including 'Copy of ', will be trimmed if the name exceeds the character limit.
The current status of the Single Send. The status may be draft, scheduled, or triggered.
Possible values:
draftscheduledtriggered
categoriesarray[string]
The categories associated with this Single Send.
send_atstring<date-time> or null
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.
segment_idsarray[string<uuid>]
The IDs of each segment to which the Single Send will be sent.
allboolean
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>
the ISO 8601 time at which the Single Send was last updated.
created_atstring<date-time>
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
The HTML content of the Single Send. This property is not used when a design_id value is set.
plain_contentstring
The plain text content of the Single Send. This property is not used when a design_id value is set.
generate_plain_contentboolean
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
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>
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
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
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
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
The name of the IP Pool from which the Single Send emails are sent.