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.
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/
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.
Bearer <<YOUR_API_KEY_HERE>>application/jsonThe name of the Single Send.
1Max length: 100Optional
The categories to associate with this Single Send.
10Optional
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.
Optional
Optional
Optional
The unique ID for the Single Send.
Optional
The name of the Single Send.
1Max length: 100Optional
The current status of the Single Send. The status may be draft, scheduled, or triggered.
draftscheduledtriggeredOptional
The categories associated with this Single Send.
10Optional
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.
Optional
Optional
the ISO 8601 time at which the Single Send was last updated.
Optional
the ISO 8601 time at which the Single Send was created.
Optional
Optional
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const id = "id";5const data = {6name: "Miss Christine Morgan",7};89const request = {10url: `/v3/marketing/singlesends/${id}`,11method: "PATCH",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});