Skip to content

Sends a test newsletter email to the given address. Returns 200 on success, 401 if the current user may not send newsletters, or 400 if the email address is invalid.

POST
/api/newsletter/test

Authorizations

api_key
Type: API Key (header: X-CSRF-Token)

Request Body

JSON
{
"address": "string",
"subject": "string",
"message": "string"
}

Responses

Authorization
api_key
cURL
curl -X POST \
'http://localhost/api/newsletter/test' \
 --data '{
  "address": "string",
  "subject": "string",
  "message": "string"
}'

Samples

cURL
curl -X POST http://localhost/api/newsletter/test
JavaScript
fetch("http://localhost/api/newsletter/test", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://localhost/api/newsletter/test");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("http://localhost/api/newsletter/test")
print(response.json())