Preview a mailing PDF

curl --request POST \
  --url https://api.gratona.com/v1/admin/mailing_templates/{id}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_type": "donor_rows",
  "selection": {
    "donor_ids": [
      42
    ],
    "hysform_id": 42,
    "donor_entity_ids": [
      42
    ],
    "program_ids": [
      42
    ],
    "program_id": 42,
    "filter": false,
    "status": "current",
    "query": "Jane",
    "savedFilterId": 42,
    "filterGroups": [
      {}
    ],
    "fields": [
      "<unknown>"
    ],
    "year": 2026,
    "household_id": 42,
    "include_soft_credits": false,
    "recipients": [
      "jane@example.org"
    ]
  },
  "artifact_kind": "letter",
  "delivery_mode": "none",
  "label_layout_preset": "single_label",
  "labels_per_sheet": 2,
  "border_labels": true
}
'

import requests

url = "https://api.gratona.com/v1/admin/mailing_templates/{id}/preview"

payload = {
    "source_type": "donor_rows",
    "selection": {
        "donor_ids": [42],
        "hysform_id": 42,
        "donor_entity_ids": [42],
        "program_ids": [42],
        "program_id": 42,
        "filter": False,
        "status": "current",
        "query": "Jane",
        "savedFilterId": 42,
        "filterGroups": [{}],
        "fields": ["<unknown>"],
        "year": 2026,
        "household_id": 42,
        "include_soft_credits": False,
        "recipients": ["jane@example.org"]
    },
    "artifact_kind": "letter",
    "delivery_mode": "none",
    "label_layout_preset": "single_label",
    "labels_per_sheet": 2,
    "border_labels": 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({
    source_type: 'donor_rows',
    selection: {
      donor_ids: [42],
      hysform_id: 42,
      donor_entity_ids: [42],
      program_ids: [42],
      program_id: 42,
      filter: false,
      status: 'current',
      query: 'Jane',
      savedFilterId: 42,
      filterGroups: [{}],
      fields: ['<unknown>'],
      year: 2026,
      household_id: 42,
      include_soft_credits: false,
      recipients: ['jane@example.org']
    },
    artifact_kind: 'letter',
    delivery_mode: 'none',
    label_layout_preset: 'single_label',
    labels_per_sheet: 2,
    border_labels: true
  })
};

fetch('https://api.gratona.com/v1/admin/mailing_templates/{id}/preview', 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/mailing_templates/{id}/preview",
  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([
    'source_type' => 'donor_rows',
    'selection' => [
        'donor_ids' => [
                42
        ],
        'hysform_id' => 42,
        'donor_entity_ids' => [
                42
        ],
        'program_ids' => [
                42
        ],
        'program_id' => 42,
        'filter' => false,
        'status' => 'current',
        'query' => 'Jane',
        'savedFilterId' => 42,
        'filterGroups' => [
                [
                                
                ]
        ],
        'fields' => [
                '<unknown>'
        ],
        'year' => 2026,
        'household_id' => 42,
        'include_soft_credits' => false,
        'recipients' => [
                'jane@example.org'
        ]
    ],
    'artifact_kind' => 'letter',
    'delivery_mode' => 'none',
    'label_layout_preset' => 'single_label',
    'labels_per_sheet' => 2,
    'border_labels' => 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/mailing_templates/{id}/preview"

	payload := strings.NewReader("{\n  \"source_type\": \"donor_rows\",\n  \"selection\": {\n    \"donor_ids\": [\n      42\n    ],\n    \"hysform_id\": 42,\n    \"donor_entity_ids\": [\n      42\n    ],\n    \"program_ids\": [\n      42\n    ],\n    \"program_id\": 42,\n    \"filter\": false,\n    \"status\": \"current\",\n    \"query\": \"Jane\",\n    \"savedFilterId\": 42,\n    \"filterGroups\": [\n      {}\n    ],\n    \"fields\": [\n      \"<unknown>\"\n    ],\n    \"year\": 2026,\n    \"household_id\": 42,\n    \"include_soft_credits\": false,\n    \"recipients\": [\n      \"jane@example.org\"\n    ]\n  },\n  \"artifact_kind\": \"letter\",\n  \"delivery_mode\": \"none\",\n  \"label_layout_preset\": \"single_label\",\n  \"labels_per_sheet\": 2,\n  \"border_labels\": 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/mailing_templates/{id}/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_type\": \"donor_rows\",\n  \"selection\": {\n    \"donor_ids\": [\n      42\n    ],\n    \"hysform_id\": 42,\n    \"donor_entity_ids\": [\n      42\n    ],\n    \"program_ids\": [\n      42\n    ],\n    \"program_id\": 42,\n    \"filter\": false,\n    \"status\": \"current\",\n    \"query\": \"Jane\",\n    \"savedFilterId\": 42,\n    \"filterGroups\": [\n      {}\n    ],\n    \"fields\": [\n      \"<unknown>\"\n    ],\n    \"year\": 2026,\n    \"household_id\": 42,\n    \"include_soft_credits\": false,\n    \"recipients\": [\n      \"jane@example.org\"\n    ]\n  },\n  \"artifact_kind\": \"letter\",\n  \"delivery_mode\": \"none\",\n  \"label_layout_preset\": \"single_label\",\n  \"labels_per_sheet\": 2,\n  \"border_labels\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/mailing_templates/{id}/preview")

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  \"source_type\": \"donor_rows\",\n  \"selection\": {\n    \"donor_ids\": [\n      42\n    ],\n    \"hysform_id\": 42,\n    \"donor_entity_ids\": [\n      42\n    ],\n    \"program_ids\": [\n      42\n    ],\n    \"program_id\": 42,\n    \"filter\": false,\n    \"status\": \"current\",\n    \"query\": \"Jane\",\n    \"savedFilterId\": 42,\n    \"filterGroups\": [\n      {}\n    ],\n    \"fields\": [\n      \"<unknown>\"\n    ],\n    \"year\": 2026,\n    \"household_id\": 42,\n    \"include_soft_credits\": false,\n    \"recipients\": [\n      \"jane@example.org\"\n    ]\n  },\n  \"artifact_kind\": \"letter\",\n  \"delivery_mode\": \"none\",\n  \"label_layout_preset\": \"single_label\",\n  \"labels_per_sheet\": 2,\n  \"border_labels\": true\n}"

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

"<string>"

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

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

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