Send a Test Marketing Email
POST /v3/marketing/test/send_email
Base url: https://api.sendgrid.com
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.
Authentication
- API Key
Headers
Request Body
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.
format: uuidYou 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.
format: uuidThis ID must belong to a verified sender. Alternatively, you may supply a from_address email.
A custom unsubscribe URL.
An array of email addresses you want to send the test message to.
maxItems: 10minItems: 1uniqueItems: TrueYou can either specify this address or specify a verified sender ID.
format: email{
"template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
"version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
"sender_id": 6060664,
"custom_unsubscribe_url": "https://example.com/unsubscribe",
"suppression_group_id": 21865513,
"emails": [
"janedoe@example.com",
"tiramisu@example.com",
"bundt@example.com"
]
}Responses
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
