Create a recipient through Zapier

POST

zapier

actions

recipients

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "program_id": 11,
  "sp_num": 1,
  "sp_amount": 25,
  "is_visible": true,
  "email": "jane@example.org",
  "json_fields": {},
  "tags": [
    "<string>"
  ],
  "idempotency_key": "external-record-001"
}
'

import requests

url = "https://api.gratona.com/v3/zapier/actions/recipients"

payload = {
    "program_id": 11,
    "sp_num": 1,
    "sp_amount": 25,
    "is_visible": True,
    "email": "jane@example.org",
    "json_fields": {},
    "tags": ["<string>"],
    "idempotency_key": "external-record-001"
}
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({
    program_id: 11,
    sp_num: 1,
    sp_amount: 25,
    is_visible: true,
    email: 'jane@example.org',
    json_fields: {},
    tags: ['<string>'],
    idempotency_key: 'external-record-001'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/recipients', 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/v3/zapier/actions/recipients",
  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([
    'program_id' => 11,
    'sp_num' => 1,
    'sp_amount' => 25,
    'is_visible' => true,
    'email' => 'jane@example.org',
    'json_fields' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'idempotency_key' => 'external-record-001'
  ]),
  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/v3/zapier/actions/recipients"

	payload := strings.NewReader("{\n  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\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/v3/zapier/actions/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v3/zapier/actions/recipients")

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  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\n}"

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

{
  "id": 4711,
  "client_id": 207,
  "program_id": 11,
  "status": 123,
  "is_visible": true,
  "is_featured": true,
  "json_fields": "<string>",
  "batch_id": null,
  "created_at": "2025-09-01T14:00:00Z",
  "updated_at": "2025-12-30T09:12:00Z",
  "deleted_at": null
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

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

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated input accepted by this Zapier transport.

program_id

integer

required

Program containing the recipient or sponsorship. Validation: required|integer.

Example:

11

sp_num

any | null

Sponsor-count target accepted by the recipient program. Compatibility input retains the primitive accepted numeric/string or tag-list representation. Validation: nullable.

Example:

1

sp_amount

any | null

Sponsorship funding target accepted by the recipient program. Compatibility input retains the primitive accepted numeric/string or tag-list representation. Validation: nullable.

Example:

25

is_visible

boolean | null

Whether the recipient is visible in public sponsorship listings. Validation: nullable|boolean.

Example:

true

string<email> | null

Profile email address. Validation: nullable|email.

Example:

"jane@example.org"

json_fields

object | null

Custom-field values keyed by the configured form field names. Validation: nullable|array.

Show child attributes

Response

Created, updated or replayed record; this transport unwraps the primitive success envelope.

A sponsorship recipient — the 'who/what' a donor sponsors. Entities can represent children, families, animals, projects, or any other sponsorable thing depending on the program. Like donors, entities have standardized columns plus arbitrary json_fields defined by the program's Hysform. Donations target an entity through the historical donation.designation column.

integer<int64>

required

Internal entity ID.

Example:

4711

client_id

integer<int64>

required

Owning Gratona client (multi-tenant scope).

Example:

207

program_id

integer<int64>

required

Program this entity belongs to. The program's hysform_id defines which custom fields appear in json_fields.

Example:

11

status

Recipient sponsorship state, commonly0unsponsored or1sponsored. Compatibility serializers may retain the numeric string.

is_visible

Whether the recipient is publicly visible. Raw compatibility model responses may use0/1.

is_featured

Whether the recipient is featured in public listings. Raw compatibility model responses may use0/1.

json_fields

Custom profile/record fields. Raw model responses retain the encoded JSON string; projection endpoints may return a decoded map or list. Use the record form definition to interpret field keys.

batch_id

integer<int64> | null

Set when the entity was created via CSV import.

Example:

null

created_at

string<date-time>

Example:

"2025-09-01T14:00:00Z"

updated_at

string<date-time>

Example:

"2025-12-30T09:12:00Z"

deleted_at

string<date-time> | null

Example:

null

Create a recipient through Zapier

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "program_id": 11,
  "sp_num": 1,
  "sp_amount": 25,
  "is_visible": true,
  "email": "jane@example.org",
  "json_fields": {},
  "tags": [
    "<string>"
  ],
  "idempotency_key": "external-record-001"
}
'

import requests

url = "https://api.gratona.com/v3/zapier/actions/recipients"

payload = {
    "program_id": 11,
    "sp_num": 1,
    "sp_amount": 25,
    "is_visible": True,
    "email": "jane@example.org",
    "json_fields": {},
    "tags": ["<string>"],
    "idempotency_key": "external-record-001"
}
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({
    program_id: 11,
    sp_num: 1,
    sp_amount: 25,
    is_visible: true,
    email: 'jane@example.org',
    json_fields: {},
    tags: ['<string>'],
    idempotency_key: 'external-record-001'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/recipients', 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/v3/zapier/actions/recipients",
  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([
    'program_id' => 11,
    'sp_num' => 1,
    'sp_amount' => 25,
    'is_visible' => true,
    'email' => 'jane@example.org',
    'json_fields' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'idempotency_key' => 'external-record-001'
  ]),
  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/v3/zapier/actions/recipients"

	payload := strings.NewReader("{\n  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\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/v3/zapier/actions/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v3/zapier/actions/recipients")

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  \"program_id\": 11,\n  \"sp_num\": 1,\n  \"sp_amount\": 25,\n  \"is_visible\": true,\n  \"email\": \"jane@example.org\",\n  \"json_fields\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"idempotency_key\": \"external-record-001\"\n}"

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

{
  "id": 4711,
  "client_id": 207,
  "program_id": 11,
  "status": 123,
  "is_visible": true,
  "is_featured": true,
  "json_fields": "<string>",
  "batch_id": null,
  "created_at": "2025-09-01T14:00:00Z",
  "updated_at": "2025-12-30T09:12:00Z",
  "deleted_at": null
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

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

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

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