Create a draft, send, or schedule a newsletter

curl --request POST \
  --url https://api.gratona.com/v1/admin/send/newsLetter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "admin@example.org",
  "message": "<p>Thank you for supporting education.</p>",
  "title": "Education field update",
  "status": "draft",
  "to": [
    42
  ],
  "emails": [
    "jane@example.org"
  ],
  "tag": "Education",
  "tags": [
    "Education"
  ],
  "audience_selection": {
    "mode": "static",
    "tags": [
      "Education"
    ],
    "individual_donor_ids": [
      42
    ],
    "excluded_tag_donor_ids": [
      42
    ]
  },
  "select_all_donors": false,
  "design": "<unknown>",
  "attachment": "https://example.org/newsletter.pdf",
  "fileName": "https://example.org/newsletter.pdf",
  "scheduled_at": "2026-10-27T15:00:00",
  "timezone": "Africa/Kampala"
}
'

import requests

url = "https://api.gratona.com/v1/admin/send/newsLetter"

payload = {
    "from": "admin@example.org",
    "message": "<p>Thank you for supporting education.</p>",
    "title": "Education field update",
    "status": "draft",
    "to": [42],
    "emails": ["jane@example.org"],
    "tag": "Education",
    "tags": ["Education"],
    "audience_selection": {
        "mode": "static",
        "tags": ["Education"],
        "individual_donor_ids": [42],
        "excluded_tag_donor_ids": [42]
    },
    "select_all_donors": False,
    "design": "<unknown>",
    "attachment": "https://example.org/newsletter.pdf",
    "fileName": "https://example.org/newsletter.pdf",
    "scheduled_at": "2026-10-27T15:00:00",
    "timezone": "Africa/Kampala"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: 'admin@example.org',
    message: '<p>Thank you for supporting education.</p>',
    title: 'Education field update',
    status: 'draft',
    to: [42],
    emails: ['jane@example.org'],
    tag: 'Education',
    tags: ['Education'],
    audience_selection: {
      mode: 'static',
      tags: ['Education'],
      individual_donor_ids: [42],
      excluded_tag_donor_ids: [42]
    },
    select_all_donors: false,
    design: '<unknown>',
    attachment: 'https://example.org/newsletter.pdf',
    fileName: 'https://example.org/newsletter.pdf',
    scheduled_at: '2026-10-27T15:00:00',
    timezone: 'Africa/Kampala'
  })
};

fetch('https://api.gratona.com/v1/admin/send/newsLetter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/send/newsLetter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => 'admin@example.org',
    'message' => '<p>Thank you for supporting education.</p>',
    'title' => 'Education field update',
    'status' => 'draft',
    'to' => [
        42
    ],
    'emails' => [
        'jane@example.org'
    ],
    'tag' => 'Education',
    'tags' => [
        'Education'
    ],
    'audience_selection' => [
        'mode' => 'static',
        'tags' => [
                'Education'
        ],
        'individual_donor_ids' => [
                42
        ],
        'excluded_tag_donor_ids' => [
                42
        ]
    ],
    'select_all_donors' => false,
    'design' => '<unknown>',
    'attachment' => 'https://example.org/newsletter.pdf',
    'fileName' => 'https://example.org/newsletter.pdf',
    'scheduled_at' => '2026-10-27T15:00:00',
    'timezone' => 'Africa/Kampala'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/send/newsLetter"

	payload := strings.NewReader("{\n  \"from\": \"admin@example.org\",\n  \"message\": \"<p>Thank you for supporting education.</p>\",\n  \"title\": \"Education field update\",\n  \"status\": \"draft\",\n  \"to\": [\n    42\n  ],\n  \"emails\": [\n    \"jane@example.org\"\n  ],\n  \"tag\": \"Education\",\n  \"tags\": [\n    \"Education\"\n  ],\n  \"audience_selection\": {\n    \"mode\": \"static\",\n    \"tags\": [\n      \"Education\"\n    ],\n    \"individual_donor_ids\": [\n      42\n    ],\n    \"excluded_tag_donor_ids\": [\n      42\n    ]\n  },\n  \"select_all_donors\": false,\n  \"design\": \"<unknown>\",\n  \"attachment\": \"https://example.org/newsletter.pdf\",\n  \"fileName\": \"https://example.org/newsletter.pdf\",\n  \"scheduled_at\": \"2026-10-27T15:00:00\",\n  \"timezone\": \"Africa/Kampala\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/send/newsLetter")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"admin@example.org\",\n  \"message\": \"<p>Thank you for supporting education.</p>\",\n  \"title\": \"Education field update\",\n  \"status\": \"draft\",\n  \"to\": [\n    42\n  ],\n  \"emails\": [\n    \"jane@example.org\"\n  ],\n  \"tag\": \"Education\",\n  \"tags\": [\n    \"Education\"\n  ],\n  \"audience_selection\": {\n    \"mode\": \"static\",\n    \"tags\": [\n      \"Education\"\n    ],\n    \"individual_donor_ids\": [\n      42\n    ],\n    \"excluded_tag_donor_ids\": [\n      42\n    ]\n  },\n  \"select_all_donors\": false,\n  \"design\": \"<unknown>\",\n  \"attachment\": \"https://example.org/newsletter.pdf\",\n  \"fileName\": \"https://example.org/newsletter.pdf\",\n  \"scheduled_at\": \"2026-10-27T15:00:00\",\n  \"timezone\": \"Africa/Kampala\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/send/newsLetter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"admin@example.org\",\n  \"message\": \"<p>Thank you for supporting education.</p>\",\n  \"title\": \"Education field update\",\n  \"status\": \"draft\",\n  \"to\": [\n    42\n  ],\n  \"emails\": [\n    \"jane@example.org\"\n  ],\n  \"tag\": \"Education\",\n  \"tags\": [\n    \"Education\"\n  ],\n  \"audience_selection\": {\n    \"mode\": \"static\",\n    \"tags\": [\n      \"Education\"\n    ],\n    \"individual_donor_ids\": [\n      42\n    ],\n    \"excluded_tag_donor_ids\": [\n      42\n    ]\n  },\n  \"select_all_donors\": false,\n  \"design\": \"<unknown>\",\n  \"attachment\": \"https://example.org/newsletter.pdf\",\n  \"fileName\": \"https://example.org/newsletter.pdf\",\n  \"scheduled_at\": \"2026-10-27T15:00:00\",\n  \"timezone\": \"Africa/Kampala\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "News letter is being sent",
  "status": "sending",
  "id": 42,
  "title": "Education field update",
  "scheduled_at": "2026-10-20T12:00:00Z",
  "timezone": "Africa/Kampala",
  "scheduled_timezone": "Africa/Kampala",
  "schedule_source": "calendar",
  "recipient_count": 1,
  "eligible_recipient_count": 1,
  "suppressed_recipient_count": 0,
  "recipient_eligibility_pending": true
}

{
  "message": "News letter is being sent",
  "status": "sending",
  "id": 42,
  "title": "Education field update",
  "scheduled_at": "2026-10-20T12:00:00Z",
  "timezone": "Africa/Kampala",
  "scheduled_timezone": "Africa/Kampala",
  "schedule_source": "calendar",
  "recipient_count": 1,
  "eligible_recipient_count": 1,
  "suppressed_recipient_count": 0,
  "recipient_eligibility_pending": true
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}