Skip to contentSkip to navigationSkip to topbar
On this page

Duplicate Single Send



API Overview

api-overview page anchor

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/


POST/v3/marketing/singlesends/{id}

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.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstringrequired
Encoding type:application/json
Schema
Property nameTypeRequiredDescriptionChild properties
namestringOptional

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.

Min length: 1Max length: 100
201404500
Schema
Property nameTypeRequiredDescriptionChild properties
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]
Duplicate Single SendLink to code sample: Duplicate Single Send
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "ZGkrHSypTsudrGkmdpJJ";
5
6
const request = {
7
url: `/v3/marketing/singlesends/${id}`,
8
method: "POST",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.