> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upsert a per-program donor-field permission override

> Sets the per-program permission override on a single donor field — either a custom field (via `donorfield_id`) or a standardized field (via `standard_field_key`). Exactly one identifier is required. Null or the field default removes the override. Loaded field and program revisions are required for stale-write protection. Requires permission: `manage_programs`.



## OpenAPI

````yaml put /admin/program/{program_id}/donor-field-overrides
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /admin/program/{program_id}/donor-field-overrides:
    put:
      tags:
        - Forms
      summary: Upsert a per-program donor-field permission override
      description: >-
        Sets the per-program permission override on a single donor field —
        either a custom field (via `donorfield_id`) or a standardized field (via
        `standard_field_key`). Exactly one identifier is required. Null or the
        field default removes the override. Loaded field and program revisions
        are required for stale-write protection. Requires permission:
        `manage_programs`.
      operationId: 35e5191de8cd4e7820c3f637d7663ac7
      parameters:
        - name: program_id
          in: path
          description: Program whose override to upsert.
          required: true
          schema:
            type: integer
          example: 11
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - permissions
                - expected_revision
                - expected_program_revision
              properties:
                donorfield_id:
                  description: Custom field id. Provide this OR `standard_field_key`.
                  type: integer
                  example: 512
                standard_field_key:
                  description: Standardized field key. Provide this OR `donorfield_id`.
                  type: string
                  example: first_name
                permissions:
                  description: >-
                    New permissions value. Null or the field default removes the
                    override.
                  type: string
                  enum:
                    - public
                    - donor
                    - admin
                  example: admin
                  nullable: true
                expected_revision:
                  description: >-
                    Loaded field row revision. Zero represents a default-backed
                    standard field with no row.
                  type: integer
                  minimum: 0
                  example: 4
                expected_program_revision:
                  description: Loaded program donor-field policy revision.
                  type: integer
                  minimum: 0
                  example: 7
              type: object
      responses:
        '200':
          description: Override upserted (or removed when matching the default).
          content:
            application/json:
              schema:
                properties:
                  data:
                    description: >-
                      Carries `donorfield_id` OR `standard_field_key` along with
                      `default_permissions` and the resulting
                      `override_permissions` (null when the override was
                      removed).
                    type: object
                    additionalProperties: true
                  status:
                    type: string
                    example: success
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '404':
          description: >-
            Program not found, custom field not on this form, or
            `donor_hysform_id` is null.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Program or donor form not found.
                type: object
        '422':
          description: >-
            Invalid `permissions` value, invalid `standard_field_key`, or
            neither identifier supplied.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Invalid permissions value.
                type: object
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.