Skip to main content
PUT
Upsert a per-program donor-field permission override

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
integer
required

Program whose override to upsert.

Body

application/json
permissions
enum<string> | null
required

New permissions value. Null or the field default removes the override.

Available options:
public,
donor,
admin
Example:

"admin"

expected_revision
integer
required

Loaded field row revision. Zero represents a default-backed standard field with no row.

Required range: x >= 0
Example:

4

expected_program_revision
integer
required

Loaded program donor-field policy revision.

Required range: x >= 0
Example:

7

donorfield_id
integer

Custom field id. Provide this OR standard_field_key.

Example:

512

standard_field_key
string

Standardized field key. Provide this OR donorfield_id.

Example:

"first_name"

Response

Override upserted (or removed when matching the default).

data
object

Carries donorfield_id OR standard_field_key along with default_permissions and the resulting override_permissions (null when the override was removed).

status
string
Example:

"success"