Communications

Send a test automated email

Queues an automated email using a tenant-owned commitment and trigger. Tests go only to the authenticated admin, bypass sample donor/form email restrictions, and do not notify the donor. A test can target one donation-type variant; it is sent only when that variant and the standard template are both on, and source details such as the DAF sponsor or IRA custodian use clearly labeled sample values. With test false, donor email preferences apply and successful queueing records donor activity. Requires admin API authentication and user permission checks.

POST

admin

test_emailset

curl --request POST \
  --url https://api.gratona.com/v1/admin/test_emailset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commitment_id": 88211,
  "trigger": "pay_receipt",
  "emailset_id": 42,
  "donation_type": "qcd",
  "receipt_context": {
    "giving_source": "daf",
    "recipient_role": "soft_credit"
  },
  "year": 2026,
  "test": true
}
'

import requests

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

payload = {
    "commitment_id": 88211,
    "trigger": "pay_receipt",
    "emailset_id": 42,
    "donation_type": "qcd",
    "receipt_context": {
        "giving_source": "daf",
        "recipient_role": "soft_credit"
    },
    "year": 2026,
    "test": True
}
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({
    commitment_id: 88211,
    trigger: 'pay_receipt',
    emailset_id: 42,
    donation_type: 'qcd',
    receipt_context: {giving_source: 'daf', recipient_role: 'soft_credit'},
    year: 2026,
    test: true
  })
};

fetch('https://api.gratona.com/v1/admin/test_emailset', 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/test_emailset",
  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([
    'commitment_id' => 88211,
    'trigger' => 'pay_receipt',
    'emailset_id' => 42,
    'donation_type' => 'qcd',
    'receipt_context' => [
        'giving_source' => 'daf',
        'recipient_role' => 'soft_credit'
    ],
    'year' => 2026,
    'test' => true
  ]),
  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/test_emailset"

	payload := strings.NewReader("{\n  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\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/test_emailset")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\n}"

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

{
  "status": "queued",
  "message": "Test email queued for delivery to admin@example.org."
}

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

{
  "message": "Not Found",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Test email payload. The controller validates the commitment, trigger, optional statement year, and optional donor-send flag.

commitment_id

integer

required

Commitment ID belonging to the authenticated client, used for donor, recipient, designation, and email-set context.

Example:

88211

trigger

string

required

Automated email trigger to render and send. Validation rule: required|string.

Example:

"pay_receipt"

emailset_id

integer | null

Email set being edited. When present it must be the email set the commitment uses, otherwise nothing is sent. Validation rule: nullable|integer.

Example:

42

donation_type

enum<string> | null

Template variant to test. Non-default variants are admin tests only and never fall back to the standard template. Defaults to default.

Available options:

default,

in_kind,

soft_credit,

daf,

qcd

Example:

"qcd"

receipt_context

object | null

Optional giving-source context. Use giving_source=daf and recipient_role=soft_credit for an advisor test; an unchanged Standard Donation copy is skipped. Missing context preserves ordinary Direct soft-credit behavior.

Show child attributes

year

integer | null

Statement year used by the year_end_statement trigger. Validation rule: nullable|integer; defaults to the current year.

Example:

2026

test

boolean | null

When true or omitted, sends to the authenticated admin; when false, sends to the donor and records activity. Validation rule: nullable|boolean.

Example:

true

Response

Email was queued for the selected recipient.

status

string

Example:

"queued"

message

string

Queue confirmation, not proof of inbox delivery.

Example:

"Test email queued for delivery to admin@example.org."

Send a test automated email

curl --request POST \
  --url https://api.gratona.com/v1/admin/test_emailset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commitment_id": 88211,
  "trigger": "pay_receipt",
  "emailset_id": 42,
  "donation_type": "qcd",
  "receipt_context": {
    "giving_source": "daf",
    "recipient_role": "soft_credit"
  },
  "year": 2026,
  "test": true
}
'

import requests

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

payload = {
    "commitment_id": 88211,
    "trigger": "pay_receipt",
    "emailset_id": 42,
    "donation_type": "qcd",
    "receipt_context": {
        "giving_source": "daf",
        "recipient_role": "soft_credit"
    },
    "year": 2026,
    "test": True
}
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({
    commitment_id: 88211,
    trigger: 'pay_receipt',
    emailset_id: 42,
    donation_type: 'qcd',
    receipt_context: {giving_source: 'daf', recipient_role: 'soft_credit'},
    year: 2026,
    test: true
  })
};

fetch('https://api.gratona.com/v1/admin/test_emailset', 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/test_emailset",
  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([
    'commitment_id' => 88211,
    'trigger' => 'pay_receipt',
    'emailset_id' => 42,
    'donation_type' => 'qcd',
    'receipt_context' => [
        'giving_source' => 'daf',
        'recipient_role' => 'soft_credit'
    ],
    'year' => 2026,
    'test' => true
  ]),
  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/test_emailset"

	payload := strings.NewReader("{\n  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\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/test_emailset")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"commitment_id\": 88211,\n  \"trigger\": \"pay_receipt\",\n  \"emailset_id\": 42,\n  \"donation_type\": \"qcd\",\n  \"receipt_context\": {\n    \"giving_source\": \"daf\",\n    \"recipient_role\": \"soft_credit\"\n  },\n  \"year\": 2026,\n  \"test\": true\n}"

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

{
  "status": "queued",
  "message": "Test email queued for delivery to admin@example.org."
}

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

{
  "message": "Not Found",
  "status": "error"
}

Overview

Admin

Admin Dashboard

Auth

Client

Communications

Donations

Donor Portal

Donor Signup

Donors

Email Settings

Entities

Files

Forms

Frontend

Historical Archived Updates

Payments

Programs

Public

Recipient Portal

Reports

Sponsorships

Team & Access

Trips

User

Webhooks

Wrapped

Send a test automated email

Authorizations

Body

Response