Skip to content Skip to navigation Skip to topbar

Send a Test Campaign

API Overview

(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on the Sender Identities API, please visit the new Marketing Campaigns Single Sends API.

The Campaigns API allows you to create and manage marketing campaigns. You can create campaigns, manage campaign content, and schedule campaigns to be sent at a later time.

Operation overview

POST/v3/campaigns/{campaign_id}/schedules/test

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

This endpoint allows you to send a test campaign.

To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Path parameters

Property nameTypeRequiredDescription

campaign_idintegerrequired

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

tostring<email>required

The email address that should receive the test campaign.

Responses

204400404

Schema

Property nameTypeRequiredDescriptionChild properties

tostring

The request was formatted incorrectly or missing required parameters.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Not found

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Send a Test Campaign

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const campaign_id = 4900;
_22const data = {
_22  "to": "your.email@example.com"
_22};
_22
_22const request = {
_22  url: `/v3/campaigns/${campaign_id}/schedules/test`,
_22  method: 'POST',
_22  body: data
_22}
_22
_22client.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  });