Skip to main content
PUT
Upsert one standardized donor field setting

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

hysform_id
integer
required

Donor form to update.

Body

application/json
standard_field_key
string
required

Must be one of DonorStandardFieldSetting::STANDARD_KEYS (first_name, phone, address, etc.).

Example:

"first_name"

expected_revision
integer
required

Loaded row revision. Zero represents a registry default with no persisted row.

Required range: x >= 0
Example:

4

is_title
boolean

Whether this field appears in donor display titles. Defaults to false.

Example:

true

permissions
enum<string>

Visibility scope. Invalid values return 422.

Available options:
public,
donor,
admin
Example:

"public"

required
boolean

Whether this field is required at signup. Defaults to false.

Example:

false

Response

Setting upserted.

data
object
status
string
Example:

"success"