Zapier

Create an externally managed sponsorship

Creates an External Processor method7, non-charging sponsorship with amount expressed per payment period. Requires Zapier sponsorship lifecycle enabled, donation management, donor/program access and primitives:commitments:create_sponsorship (or primitives:*). external_reference identifies a replay-protected recurring record. Do not send payment_method, method, is_non_charging, is_per_period_amount or arb_subscription_id: these fields are prohibited and controlled by this action.

POST

zapier

actions

sponsorships

Create an externally managed sponsorship

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/sponsorships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "donor_id": 12345,
  "recipient_id": 4711,
  "amount": 25,
  "frequency_id": 1,
  "next_payment_date": "2026-11-01",
  "external_reference": "external-recurring-001",
  "start_date": "2026-10-20",
  "until": "2027-11-01"
}
'

import requests

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

payload = {
    "donor_id": 12345,
    "recipient_id": 4711,
    "amount": 25,
    "frequency_id": 1,
    "next_payment_date": "2026-11-01",
    "external_reference": "external-recurring-001",
    "start_date": "2026-10-20",
    "until": "2027-11-01"
}
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({
    donor_id: 12345,
    recipient_id: 4711,
    amount: 25,
    frequency_id: 1,
    next_payment_date: '2026-11-01',
    external_reference: 'external-recurring-001',
    start_date: '2026-10-20',
    until: '2027-11-01'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/sponsorships', 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/sponsorships",
  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([
    'donor_id' => 12345,
    'recipient_id' => 4711,
    'amount' => 25,
    'frequency_id' => 1,
    'next_payment_date' => '2026-11-01',
    'external_reference' => 'external-recurring-001',
    'start_date' => '2026-10-20',
    'until' => '2027-11-01'
  ]),
  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/sponsorships"

	payload := strings.NewReader("{\n  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\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/sponsorships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\n}"

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

{
  "id": 12345,
  "commitment_id": 12345,
  "sponsorship_id": 12345,
  "donor_entity_id": 12345,
  "donor_id": 12345,
  "donor_form_id": 12345,
  "program_id": 11,
  "recipient_id": 4711,
  "fund_id": 12345,
  "designation_id": 12345,
  "type": 12345,
  "frequency": 12345,
  "frequency_id": 1,
  "method": 1,
  "method_id": 12345,
  "program_name": "example",
  "recipient_name": "example",
  "fund_name": "example",
  "designation_name": "example",
  "designation_type": "example",
  "amount_basis": "example",
  "frequency_label": "example",
  "method_label": "example",
  "until": "2027-11-01",
  "last": "example",
  "first_payment_date": "example",
  "next_payment_date": "2026-11-01",
  "last_payment_date": "example",
  "paid_through_date": "example",
  "status": "active",
  "amount": 25,
  "charge_amount": 25,
  "monthly_equivalent_amount": 25,
  "last_payment_amount": 25,
  "is_per_period_amount": false,
  "is_recurring": false,
  "is_non_charging": false,
  "funding": false,
  "archived": false,
  "designation": 4711,
  "donor": {
    "id": 12345,
    "hysform_id": 42,
    "display_name": "example",
    "email": "jane@example.org",
    "username": "jane.doe",
    "fields": "<unknown>"
  },
  "designation_details": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "recipient": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "fund": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "created_at": "2026-10-20T10:00:00Z",
  "updated_at": "2026-10-20T10:00:00Z",
  "external_reference": "external-recurring-001",
  "start_date": "2026-10-20"
}

{
  "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.

donor_id

integer

required

Donor who owns the gift or commitment. Validation: required|integer|min:1.

Required range: x >= 1

Example:

12345

recipient_id

integer

required

Recipient selected for the sponsorship. Validation: required|integer|min:1.

Required range: x >= 1

Example:

4711

amount

number

required

Individual gift amount in the supplied currency. Validation: required|numeric|min:0.01|max:99999999.99.

Required range: 0.01 <= x <= 99999999.99

Example:

25

frequency_id

enum<integer>

required

Recurring schedule code; amount is per payment period. Validation: required|integer|in:1,2,3,4,6,7.

Available options:

1,

2,

3,

4,

6,

7

Example:

1

next_payment_date

string<date>

required

Next externally managed payment date. Validation: required|date_format:Y-m-d.

Example:

"2026-11-01"

external_reference

string

required

Stable external record/reference identifying this mutation occurrence. Validation: required|string|max:191.

Maximum string length: 191

Example:

"external-recurring-001"

start_date

string<date> | null

Optional start date, no later than next_payment_date. Validation: nullable|date_format:Y-m-d|before_or_equal:next_payment_date.

Example:

"2026-10-20"

until

string<date> | null

Optional end date, no earlier than next_payment_date. Validation: nullable|date_format:Y-m-d|after_or_equal:next_payment_date.

Example:

"2027-11-01"

Response

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

Created/replayed externally managed non-charging commitment.

integer

Created commitment identifier.

Example:

12345

commitment_id

integer | null

Commitment id.

Example:

12345

sponsorship_id

integer | null

Sponsorship id.

Example:

12345

donor_entity_id

integer | null

Donor entity id.

Example:

12345

donor_id

integer | null

Donor who owns the gift or commitment.

Example:

12345

donor_form_id

integer | null

Donor form id.

Example:

12345

program_id

integer | null

Program containing the recipient or sponsorship.

Example:

11

recipient_id

integer | null

Recipient selected for the sponsorship.

Example:

4711

fund_id

integer | null

Fund id.

Example:

12345

designation_id

integer | null

Designation id.

Example:

12345

type

integer | null

Record type accepted by this operation.

Example:

12345

frequency

integer | null

Frequency.

Example:

12345

frequency_id

integer | null

Recurring schedule code; amount is per payment period.

Example:

1

method

integer | null

Stored compatibility payment method identifier.

Example:

1

method_id

integer | null

Method id.

Example:

12345

program_name

string | null

Program name.

Example:

"example"

recipient_name

string | null

Recipient name.

Example:

"example"

fund_name

string | null

Fund name.

Example:

"example"

designation_name

string | null

Designation name.

Example:

"example"

designation_type

string | null

Designation type.

Example:

"example"

amount_basis

string | null

Amount basis.

Example:

"example"

frequency_label

string | null

Frequency label.

Example:

"example"

method_label

string | null

Method label.

Example:

"example"

until

string | null

Optional end date, no earlier than next_payment_date.

Example:

"2027-11-01"

last

string | null

Last.

Example:

"example"

first_payment_date

string | null

First payment date.

Example:

"example"

next_payment_date

string | null

Next externally managed payment date.

Example:

"2026-11-01"

last_payment_date

string | null

Last payment date.

Example:

"example"

paid_through_date

string | null

Paid through date.

Example:

"example"

status

string | null

Requested active or archived lifecycle state.

Example:

"active"

amount

number | null

Individual gift amount in the supplied currency.

Example:

25

charge_amount

number | null

Charge amount.

Example:

25

monthly_equivalent_amount

number | null

Monthly equivalent amount.

Example:

25

last_payment_amount

number | null

Last payment amount.

Example:

25

is_per_period_amount

boolean | null

Is per period amount.

Example:

false

is_recurring

boolean | null

Is recurring.

Example:

false

is_non_charging

boolean | null

Is non charging.

Example:

false

funding

boolean | null

Funding.

Example:

false

archived

boolean | null

Archived.

Example:

false

designation

any | null

Recipient/designation identifier for the donation.

Example:

4711

donor

Donor id, hysform_id, display_name, email, username and resolved fields; null when unavailable.

Show child attributes

designation_details

Resolved designation metadata.

Show child attributes

recipient

Recipient designation details, otherwise null.

Show child attributes

fund

Fund designation details, otherwise null.

Show child attributes

created_at

string | null

Created at.

Example:

"2026-10-20T10:00:00Z"

updated_at

string | null

Updated at.

Example:

"2026-10-20T10:00:00Z"

external_reference

string | null

Stable external record/reference identifying this mutation occurrence.

Example:

"external-recurring-001"

start_date

string | null

Optional start date, no later than next_payment_date.

Example:

"2026-10-20"

Create an externally managed sponsorship

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/sponsorships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "donor_id": 12345,
  "recipient_id": 4711,
  "amount": 25,
  "frequency_id": 1,
  "next_payment_date": "2026-11-01",
  "external_reference": "external-recurring-001",
  "start_date": "2026-10-20",
  "until": "2027-11-01"
}
'

import requests

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

payload = {
    "donor_id": 12345,
    "recipient_id": 4711,
    "amount": 25,
    "frequency_id": 1,
    "next_payment_date": "2026-11-01",
    "external_reference": "external-recurring-001",
    "start_date": "2026-10-20",
    "until": "2027-11-01"
}
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({
    donor_id: 12345,
    recipient_id: 4711,
    amount: 25,
    frequency_id: 1,
    next_payment_date: '2026-11-01',
    external_reference: 'external-recurring-001',
    start_date: '2026-10-20',
    until: '2027-11-01'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/sponsorships', 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/sponsorships",
  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([
    'donor_id' => 12345,
    'recipient_id' => 4711,
    'amount' => 25,
    'frequency_id' => 1,
    'next_payment_date' => '2026-11-01',
    'external_reference' => 'external-recurring-001',
    'start_date' => '2026-10-20',
    'until' => '2027-11-01'
  ]),
  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/sponsorships"

	payload := strings.NewReader("{\n  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\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/sponsorships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"donor_id\": 12345,\n  \"recipient_id\": 4711,\n  \"amount\": 25,\n  \"frequency_id\": 1,\n  \"next_payment_date\": \"2026-11-01\",\n  \"external_reference\": \"external-recurring-001\",\n  \"start_date\": \"2026-10-20\",\n  \"until\": \"2027-11-01\"\n}"

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

{
  "id": 12345,
  "commitment_id": 12345,
  "sponsorship_id": 12345,
  "donor_entity_id": 12345,
  "donor_id": 12345,
  "donor_form_id": 12345,
  "program_id": 11,
  "recipient_id": 4711,
  "fund_id": 12345,
  "designation_id": 12345,
  "type": 12345,
  "frequency": 12345,
  "frequency_id": 1,
  "method": 1,
  "method_id": 12345,
  "program_name": "example",
  "recipient_name": "example",
  "fund_name": "example",
  "designation_name": "example",
  "designation_type": "example",
  "amount_basis": "example",
  "frequency_label": "example",
  "method_label": "example",
  "until": "2027-11-01",
  "last": "example",
  "first_payment_date": "example",
  "next_payment_date": "2026-11-01",
  "last_payment_date": "example",
  "paid_through_date": "example",
  "status": "active",
  "amount": 25,
  "charge_amount": 25,
  "monthly_equivalent_amount": 25,
  "last_payment_amount": 25,
  "is_per_period_amount": false,
  "is_recurring": false,
  "is_non_charging": false,
  "funding": false,
  "archived": false,
  "designation": 4711,
  "donor": {
    "id": 12345,
    "hysform_id": 42,
    "display_name": "example",
    "email": "jane@example.org",
    "username": "jane.doe",
    "fields": "<unknown>"
  },
  "designation_details": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "recipient": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "fund": {
    "id": 12345,
    "program_id": 11,
    "status": 12345,
    "display_name": "example",
    "email": "jane@example.org",
    "type": "individual",
    "fields": "<unknown>"
  },
  "created_at": "2026-10-20T10:00:00Z",
  "updated_at": "2026-10-20T10:00:00Z",
  "external_reference": "external-recurring-001",
  "start_date": "2026-10-20"
}

{
  "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."
}