Donors
Kick off the rule-based duplicate scan (async)
Newer scan flow that uses the configured DuplicateRule ruleset. Creates a DuplicateScanRun row (with scan_settings.enhanced=true) and dispatches EnhancedDuplicateDetectionJob. Returns the scan run ID immediately (HTTP 202) — poll /admin/duplicates/scans/{scan_run_id}/progress and read results from /admin/donors/duplicates/results. Requires permission: duplicates_manage (also satisfied by donors_manage).
POST
/
admin
/
donors
/
{hysform_id}
/
duplicates
/
enhanced
Kick off the rule-based duplicate scan (async)
curl --request POST \
--url https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trashed": "false"
}
'import requests
url = "https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced"
payload = { "trashed": "false" }
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({trashed: 'false'})
};
fetch('https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced', 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/donors/{hysform_id}/duplicates/enhanced",
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([
'trashed' => 'false'
]),
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/donors/{hysform_id}/duplicates/enhanced"
payload := strings.NewReader("{\n \"trashed\": \"false\"\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/donors/{hysform_id}/duplicates/enhanced")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"trashed\": \"false\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced")
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 \"trashed\": \"false\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Enhanced duplicate scan started",
"scan_run_id": 512
}{
"message": "Unauthorized",
"status": "error"
}{
"success": false,
"message": "Failed to start enhanced duplicate scan",
"error": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Donor form to scan.
Body
application/json
When truthy, includes archived donors. Stored in scan_settings.trashed.
Example:
"false"
⌘I
Kick off the rule-based duplicate scan (async)
curl --request POST \
--url https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trashed": "false"
}
'import requests
url = "https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced"
payload = { "trashed": "false" }
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({trashed: 'false'})
};
fetch('https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced', 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/donors/{hysform_id}/duplicates/enhanced",
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([
'trashed' => 'false'
]),
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/donors/{hysform_id}/duplicates/enhanced"
payload := strings.NewReader("{\n \"trashed\": \"false\"\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/donors/{hysform_id}/duplicates/enhanced")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"trashed\": \"false\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/donors/{hysform_id}/duplicates/enhanced")
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 \"trashed\": \"false\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Enhanced duplicate scan started",
"scan_run_id": 512
}{
"message": "Unauthorized",
"status": "error"
}{
"success": false,
"message": "Failed to start enhanced duplicate scan",
"error": "<string>"
}