Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update Single Send



API Overview

api-overview page anchor

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/


PATCH/v3/marketing/singlesends/{id}

Base url: https://api.sendgrid.com

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.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
idstringrequired
Schema
namestringrequired

The name of the Single Send.

Min length: 1Max length: 100

categoriesarray[string]

The categories to associate with this Single Send.


send_atstring<date-time> or null

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.


send_toobject

email_configobject
202400404500
Schema
idstring<uuid>

The unique ID for the Single Send.


namestring

The name of the Single Send.

Min length: 1Max length: 100

statusenum<string>

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.


send_toobject

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.


email_configobject

warningsarray[object]

Update Single Send

update-single-send page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const id = "ZGkrHSypTsudrGkmdpJJ";
_22
const data = {
_22
"name": "Miss Christine Morgan"
_22
};
_22
_22
const request = {
_22
url: `/v3/marketing/singlesends/${id}`,
_22
method: 'PATCH',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: