Edit a donor

PATCH

donor

{id}

edit

Edit a donor

curl --request PATCH \
  --url https://api.gratona.com/v1/donor/{id}/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "jane.donor",
  "email": "jane@example.org",
  "password": "new-donor-password",
  "type": "INDIVIDUAL",
  "first_name": "Jane",
  "last_name": "Doe",
  "organization_name": "Example Foundation",
  "phone": "+12565550123",
  "street": "123 Main Street",
  "address_line2": "Suite 2",
  "city": "Huntsville",
  "zip": "35801",
  "country_code": "US",
  "subdivision_code": "US-AL",
  "preferred_contact_method": "email",
  "can_receive_sms": false,
  "do_not_email": false,
  "do_not_mail": false,
  "tags": [
    "Major Donor",
    "Newsletter"
  ],
  "policy_revision": "loaded-form-policy-revision",
  "expected_type": "INDIVIDUAL",
  "expected_profile_revision": 4,
  "confirm_identity_transition": true
}
'

import requests

url = "https://api.gratona.com/v1/donor/{id}/edit"

payload = {
    "username": "jane.donor",
    "email": "jane@example.org",
    "password": "new-donor-password",
    "type": "INDIVIDUAL",
    "first_name": "Jane",
    "last_name": "Doe",
    "organization_name": "Example Foundation",
    "phone": "+12565550123",
    "street": "123 Main Street",
    "address_line2": "Suite 2",
    "city": "Huntsville",
    "zip": "35801",
    "country_code": "US",
    "subdivision_code": "US-AL",
    "preferred_contact_method": "email",
    "can_receive_sms": False,
    "do_not_email": False,
    "do_not_mail": False,
    "tags": ["Major Donor", "Newsletter"],
    "policy_revision": "loaded-form-policy-revision",
    "expected_type": "INDIVIDUAL",
    "expected_profile_revision": 4,
    "confirm_identity_transition": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: 'jane.donor',
    email: 'jane@example.org',
    password: 'new-donor-password',
    type: 'INDIVIDUAL',
    first_name: 'Jane',
    last_name: 'Doe',
    organization_name: 'Example Foundation',
    phone: '+12565550123',
    street: '123 Main Street',
    address_line2: 'Suite 2',
    city: 'Huntsville',
    zip: '35801',
    country_code: 'US',
    subdivision_code: 'US-AL',
    preferred_contact_method: 'email',
    can_receive_sms: false,
    do_not_email: false,
    do_not_mail: false,
    tags: ['Major Donor', 'Newsletter'],
    policy_revision: 'loaded-form-policy-revision',
    expected_type: 'INDIVIDUAL',
    expected_profile_revision: 4,
    confirm_identity_transition: true
  })
};

fetch('https://api.gratona.com/v1/donor/{id}/edit', 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/donor/{id}/edit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'jane.donor',
    'email' => 'jane@example.org',
    'password' => 'new-donor-password',
    'type' => 'INDIVIDUAL',
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'organization_name' => 'Example Foundation',
    'phone' => '+12565550123',
    'street' => '123 Main Street',
    'address_line2' => 'Suite 2',
    'city' => 'Huntsville',
    'zip' => '35801',
    'country_code' => 'US',
    'subdivision_code' => 'US-AL',
    'preferred_contact_method' => 'email',
    'can_receive_sms' => false,
    'do_not_email' => false,
    'do_not_mail' => false,
    'tags' => [
        'Major Donor',
        'Newsletter'
    ],
    'policy_revision' => 'loaded-form-policy-revision',
    'expected_type' => 'INDIVIDUAL',
    'expected_profile_revision' => 4,
    'confirm_identity_transition' => 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/donor/{id}/edit"

	payload := strings.NewReader("{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/donor/{id}/edit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/donor/{id}/edit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}"

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

{
  "status": "success",
  "data": {
    "message": "Profile saved"
  }
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

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

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

integer

required

ID of the donor whose profile is being edited.

Body

application/json

Donor profile fields. The organization and donor form are taken from the authenticated context and existing donor. Include any required standard or custom fields from the donor form contract.

username

string

Minimum string length: 5

Example:

"jane.donor"

string<email> | null

Email address; must be unique within the organization when provided.

Example:

"jane@example.org"

password

string<password>

Optional replacement password; an empty value leaves the existing password unchanged.

Minimum string length: 5

Example:

"new-donor-password"

type

enum<string>

Donor identity type. Changing an existing type requires the transition confirmation fields.

Available options:

INDIVIDUAL,

ORGANIZATION

Example:

"INDIVIDUAL"

first_name

string | null

Individual first name on standardized donor forms; form configuration controls whether it is required.

Example:

"Jane"

last_name

string | null

Individual last name on standardized donor forms; form configuration controls whether it is required.

Example:

"Doe"

organization_name

string

Required when the submitted donor type is ORGANIZATION.

Maximum string length: 255

Example:

"Example Foundation"

phone

string | null

Phone number on standardized donor forms.

Example:

"+12565550123"

street

string | null

Street address on standardized donor forms.

Example:

"123 Main Street"

address_line2

string | null

Additional address line on standardized donor forms.

Example:

"Suite 2"

city

string | null

City on standardized donor forms.

Example:

"Huntsville"

zip

string | null

Postal code on standardized donor forms.

Example:

"35801"

country_code

string | null

Valid two-letter country code on standardized donor forms.

Required string length: 2

Example:

"US"

subdivision_code

string | null

Subdivision code belonging to the submitted country on standardized donor forms.

Maximum string length: 10

Example:

"US-AL"

preferred_contact_method

enum<string> | null

Preferred communication channel; nullable to clear the preference.

Available options:

email,

phone,

sms,

mail

Example:

"email"

can_receive_sms

boolean

Whether the donor can receive SMS messages.

Example:

false

do_not_email

boolean

Whether the donor should be excluded from email communications.

Example:

false

do_not_mail

boolean

Whether the donor should be excluded from postal mail communications.

Example:

false

Response

Donor profile saved

status

string

Example:

"success"

data

object

Show child attributes

Edit a donor

curl --request PATCH \
  --url https://api.gratona.com/v1/donor/{id}/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "jane.donor",
  "email": "jane@example.org",
  "password": "new-donor-password",
  "type": "INDIVIDUAL",
  "first_name": "Jane",
  "last_name": "Doe",
  "organization_name": "Example Foundation",
  "phone": "+12565550123",
  "street": "123 Main Street",
  "address_line2": "Suite 2",
  "city": "Huntsville",
  "zip": "35801",
  "country_code": "US",
  "subdivision_code": "US-AL",
  "preferred_contact_method": "email",
  "can_receive_sms": false,
  "do_not_email": false,
  "do_not_mail": false,
  "tags": [
    "Major Donor",
    "Newsletter"
  ],
  "policy_revision": "loaded-form-policy-revision",
  "expected_type": "INDIVIDUAL",
  "expected_profile_revision": 4,
  "confirm_identity_transition": true
}
'

import requests

url = "https://api.gratona.com/v1/donor/{id}/edit"

payload = {
    "username": "jane.donor",
    "email": "jane@example.org",
    "password": "new-donor-password",
    "type": "INDIVIDUAL",
    "first_name": "Jane",
    "last_name": "Doe",
    "organization_name": "Example Foundation",
    "phone": "+12565550123",
    "street": "123 Main Street",
    "address_line2": "Suite 2",
    "city": "Huntsville",
    "zip": "35801",
    "country_code": "US",
    "subdivision_code": "US-AL",
    "preferred_contact_method": "email",
    "can_receive_sms": False,
    "do_not_email": False,
    "do_not_mail": False,
    "tags": ["Major Donor", "Newsletter"],
    "policy_revision": "loaded-form-policy-revision",
    "expected_type": "INDIVIDUAL",
    "expected_profile_revision": 4,
    "confirm_identity_transition": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: 'jane.donor',
    email: 'jane@example.org',
    password: 'new-donor-password',
    type: 'INDIVIDUAL',
    first_name: 'Jane',
    last_name: 'Doe',
    organization_name: 'Example Foundation',
    phone: '+12565550123',
    street: '123 Main Street',
    address_line2: 'Suite 2',
    city: 'Huntsville',
    zip: '35801',
    country_code: 'US',
    subdivision_code: 'US-AL',
    preferred_contact_method: 'email',
    can_receive_sms: false,
    do_not_email: false,
    do_not_mail: false,
    tags: ['Major Donor', 'Newsletter'],
    policy_revision: 'loaded-form-policy-revision',
    expected_type: 'INDIVIDUAL',
    expected_profile_revision: 4,
    confirm_identity_transition: true
  })
};

fetch('https://api.gratona.com/v1/donor/{id}/edit', 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/donor/{id}/edit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'jane.donor',
    'email' => 'jane@example.org',
    'password' => 'new-donor-password',
    'type' => 'INDIVIDUAL',
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'organization_name' => 'Example Foundation',
    'phone' => '+12565550123',
    'street' => '123 Main Street',
    'address_line2' => 'Suite 2',
    'city' => 'Huntsville',
    'zip' => '35801',
    'country_code' => 'US',
    'subdivision_code' => 'US-AL',
    'preferred_contact_method' => 'email',
    'can_receive_sms' => false,
    'do_not_email' => false,
    'do_not_mail' => false,
    'tags' => [
        'Major Donor',
        'Newsletter'
    ],
    'policy_revision' => 'loaded-form-policy-revision',
    'expected_type' => 'INDIVIDUAL',
    'expected_profile_revision' => 4,
    'confirm_identity_transition' => 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/donor/{id}/edit"

	payload := strings.NewReader("{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/donor/{id}/edit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/donor/{id}/edit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"jane.donor\",\n  \"email\": \"jane@example.org\",\n  \"password\": \"new-donor-password\",\n  \"type\": \"INDIVIDUAL\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"organization_name\": \"Example Foundation\",\n  \"phone\": \"+12565550123\",\n  \"street\": \"123 Main Street\",\n  \"address_line2\": \"Suite 2\",\n  \"city\": \"Huntsville\",\n  \"zip\": \"35801\",\n  \"country_code\": \"US\",\n  \"subdivision_code\": \"US-AL\",\n  \"preferred_contact_method\": \"email\",\n  \"can_receive_sms\": false,\n  \"do_not_email\": false,\n  \"do_not_mail\": false,\n  \"tags\": [\n    \"Major Donor\",\n    \"Newsletter\"\n  ],\n  \"policy_revision\": \"loaded-form-policy-revision\",\n  \"expected_type\": \"INDIVIDUAL\",\n  \"expected_profile_revision\": 4,\n  \"confirm_identity_transition\": true\n}"

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

{
  "status": "success",
  "data": {
    "message": "Profile saved"
  }
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

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

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

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

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

Authorizations

Path Parameters

Body

Response