Campaigns API
Elements that can be shared among more than one endpoint definition.
Send a Test Campaign
POST /campaigns/{campaign_id}/schedules/test
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"]
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Request Body
object
to
string
The email address that should receive the test campaign.
format: emailrequired
{
"to": "your.email@example.com"
}Path Parameters
campaign_id
integer
default: None
required
Responses
object
to
string
required
object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.