On this page

Send a Test Marketing Email

Operation overview

POST/v3/marketing/test/send_email

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to send a test marketing email to a list of email addresses.

Before sending a marketing message, you can test it using this endpoint. You may specify up to 10 contacts in the emails request body field. You must also specify a template_id and include either a from_address or sender_id. You can manage your templates with the Twilio SendGrid App or the Transactional Templates API.

Please note that this endpoint works with Dynamic Transactional Templates only. Legacy Transactional Templates will not be delivered.

For more information about managing Dynamic Transactional Templates, see How to Send Email with Dynamic Transactional Templates.

You can also test your Single Sends in the Twilio SendGrid Marketing Campaigns UI.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

template_idstring<uuid>required

The ID of the template that you would like to use. If you use a template that contains a subject and content (either text or HTML), then those values specified at the personalizations or message level will not be used.

version_id_overridestring<uuid>Optional

You can override the active template with an alternative template version by passing the version ID in this field. If this field is blank, the active template version will be used.

sender_idintegerOptional

This ID must belong to a verified sender. Alternatively, you may supply a from_address email.

custom_unsubscribe_urlstringOptional

A custom unsubscribe URL.

suppression_group_idintegerOptional

emailsarray[string<email>]required

An array of email addresses you want to send the test message to.

from_addressstring<email>Optional

You can either specify this address or specify a verified sender ID.

Responses

202400

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Send a Test Marketing Email

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
6  "version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
7  "sender_id": 6060664,
8  "custom_unsubscribe_url": "https://example.com/unsubscribe",
9  "suppression_group_id": 21865513,
10  "emails": [
11    "janedoe@example.com",
12    "tiramisu@example.com",
13    "bundt@example.com"
14  ]
15};
16
17const request = {
18  url: `/v3/marketing/test/send_email`,
19  method: 'POST',
20  body: data
21}
22
23client.request(request)
24  .then(([response, body]) => {
25    console.log(response.statusCode);
26    console.log(response.body);
27  })
28  .catch(error => {
29    console.error(error);
30  });