Forms
Upsert one standardized donor field setting
Partially updates one configurable standardized donor field. Invalid values return 422; omitted attributes, compatibility mappings, and program overrides are preserved. expected_revision is required for stale-write protection. Requires the forms permission.
PUT
/
admin
/
forms
/
{hysform_id}
/
standard-field-settings
Upsert one standardized donor field setting
curl --request PUT \
--url https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"standard_field_key": "first_name",
"expected_revision": 4,
"is_title": true,
"permissions": "public",
"required": false
}
'import requests
url = "https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings"
payload = {
"standard_field_key": "first_name",
"expected_revision": 4,
"is_title": True,
"permissions": "public",
"required": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
standard_field_key: 'first_name',
expected_revision: 4,
is_title: true,
permissions: 'public',
required: false
})
};
fetch('https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings', 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/forms/{hysform_id}/standard-field-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'standard_field_key' => 'first_name',
'expected_revision' => 4,
'is_title' => true,
'permissions' => 'public',
'required' => 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/forms/{hysform_id}/standard-field-settings"
payload := strings.NewReader("{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"standard_field_key": "<string>",
"is_title": true,
"permissions": "<string>",
"required": true,
"legacy_field_keys": [
"<string>"
]
},
"status": "success"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"message": "Invalid standard_field_key.",
"status": "error"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Donor form to update.
Body
application/json
Must be one of DonorStandardFieldSetting::STANDARD_KEYS (first_name, phone, address, etc.).
Example:
"first_name"
Loaded row revision. Zero represents a registry default with no persisted row.
Required range:
x >= 0Example:
4
Whether this field appears in donor display titles. Defaults to false.
Example:
true
Visibility scope. Invalid values return 422.
Available options:
public, donor, admin Example:
"public"
Whether this field is required at signup. Defaults to false.
Example:
false
⌘I
Upsert one standardized donor field setting
curl --request PUT \
--url https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"standard_field_key": "first_name",
"expected_revision": 4,
"is_title": true,
"permissions": "public",
"required": false
}
'import requests
url = "https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings"
payload = {
"standard_field_key": "first_name",
"expected_revision": 4,
"is_title": True,
"permissions": "public",
"required": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
standard_field_key: 'first_name',
expected_revision: 4,
is_title: true,
permissions: 'public',
required: false
})
};
fetch('https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings', 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/forms/{hysform_id}/standard-field-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'standard_field_key' => 'first_name',
'expected_revision' => 4,
'is_title' => true,
'permissions' => 'public',
'required' => 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/forms/{hysform_id}/standard-field-settings"
payload := strings.NewReader("{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/forms/{hysform_id}/standard-field-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"standard_field_key\": \"first_name\",\n \"expected_revision\": 4,\n \"is_title\": true,\n \"permissions\": \"public\",\n \"required\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"standard_field_key": "<string>",
"is_title": true,
"permissions": "<string>",
"required": true,
"legacy_field_keys": [
"<string>"
]
},
"status": "success"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"message": "Invalid standard_field_key.",
"status": "error"
}