Test a campaign
Request
Parameter |
In |
Type |
Required |
Description |
---|---|---|---|---|
|
header |
string |
true |
Determines the expected format and data type to retrieve the response data. Value: |
|
path |
string |
true |
The ID of the draft campaign that you want to test. |
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
query |
string |
true |
The API key of your account. |
|
body |
array |
true |
A list of email addresses that you want to use to send your test campaign. Use a comma (,) to separate up to a maximum of five email addresses. |
POST https://{hostname}/v3/campaigns/{CampaignID}/send_test.{Format}?apikey=
Request body:
{
"TestEmails": [
"[email protected]",
"[email protected]"
]
}
Response
Status |
Description |
Headers |
Schema |
---|---|---|---|
|
The request is successful. |
|
N/A |
{
"Code": 0,
"Error": null,
"Context": null
}
-
Code
- the response code. This is0
if successful. -
Error
- the response error message. This isnull
if successful. -
Context
- this isnull
if successful.