> ## 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.

# Update program website settings

> Requires manage_settings and access to the attached setting. Only supported nested settings keys are accepted. With multiple linked programs, mode defaults to program_copy; mode=direct requires confirm_shared_update=true, otherwise409 returns the linked-program list. No-op writes return200 with save_mode=direct. The response includes fresh launch context. Changing enabled blur configuration queues image regeneration; recipient portal synchronization follows saving. Requires permission: one of manage_programs.



## OpenAPI

````yaml patch /admin/program/{program_id}/launch-settings
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 commitment relationships, lifecycle transitions, and
      commitment-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: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/program/{program_id}/launch-settings:
    patch:
      tags:
        - Programs
      summary: Update program website settings
      description: >-
        Requires manage_settings and access to the attached setting. Only
        supported nested settings keys are accepted. With multiple linked
        programs, mode defaults to program_copy; mode=direct requires
        confirm_shared_update=true, otherwise409 returns the linked-program
        list. No-op writes return200 with save_mode=direct. The response
        includes fresh launch context. Changing enabled blur configuration
        queues image regeneration; recipient portal synchronization follows
        saving. Requires permission: one of manage_programs.
      operationId: reference_Admin_ProgramController_patchProgramLaunchSettings
      parameters:
        - name: program_id
          in: path
          description: Program id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      requestBody:
        description: Validated request fields for this operation.
        required: true
        content:
          application/json:
            schema:
              required:
                - settings
              properties:
                mode:
                  type: string
                  enum:
                    - direct
                    - program_copy
                    - null
                  example: program_copy
                  nullable: true
                confirm_shared_update:
                  description: Confirm changing a setting shared by multiple programs.
                  type: boolean
                  example: false
                  nullable: true
                settings:
                  $ref: '#/components/schemas/ProgramLaunchPatch'
              type: object
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Website settings updated.
                  save_mode:
                    type: string
                    enum:
                      - direct
                      - program_copy
                    example: direct
                  context:
                    $ref: '#/components/schemas/ProgramLaunchContext'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '404':
          description: The program is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '409':
          description: >-
            A shared setting requires explicit direct-update confirmation;
            includes shared_setting, linked_programs_count and linked_programs.
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    ProgramLaunchPatch:
      minProperties: 1
      properties:
        sponsorship_amount_mode:
          description: Contribution programs only.
          type: string
          enum:
            - remaining_balance
            - fixed_levels
          example: remaining_balance
        sponsorship_level_thresholds:
          description: >-
            JSON-encoded object of at most100 unique positive amounts (at
            most2decimals) to funding percentages greater than0 and at most100.
            Contribution programs only.
          type: string
          example: '{`25`:10,`50`:20}'
        allow_sponsorship_over_target:
          description: >-
            Contribution programs only. Accepted
            boolean,0/1,string0/string1,blank,empty list or list containing only
            string1.
          oneOf:
            - type: boolean
            - type: integer
              enum:
                - 0
                - 1
            - type: string
              enum:
                - ''
                - '0'
                - '1'
            - type: array
              items:
                type: string
                enum:
                  - '1'
              maxItems: 1
        relationship_only_sponsorships:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        campaign_theme:
          description: >-
            Supported launch setting. Scalar values are trimmed and limited
            to500bytes.
          type: string
          maxLength: 500
          example: ''
          nullable: true
        directory_columns:
          description: >-
            Map or JSON-encoded map of optional mobile1–2,tablet1–3,desktop1–4
            cards per row. Null, blank or empty list resets the layout. Unknown
            breakpoints and lists of values are rejected.
          oneOf:
            - type: string
              nullable: true
            - properties:
                mobile:
                  type: integer
                  maximum: 2
                  minimum: 1
                  nullable: true
                tablet:
                  type: integer
                  maximum: 3
                  minimum: 1
                  nullable: true
                desktop:
                  type: integer
                  maximum: 4
                  minimum: 1
                  nullable: true
              type: object
              additionalProperties: false
            - type: array
              items: {}
              maxItems: 0
        color_theme:
          description: >-
            Configured palette name/shade or custom six-digit hex with
            color_level600. Null removes the program color override. A
            JSON-encoded color object is also accepted.
          oneOf:
            - type: string
              nullable: true
            - required:
                - color
                - color_level
              properties:
                color:
                  type: string
                  example: indigo
                color_level:
                  type: integer
                  example: 600
              type: object
        child_sponsorship_button_text:
          description: Trimmed button label, at most80bytes.
          type: string
          maxLength: 80
          example: Sponsor now
        campaign_sponsorship_button_text:
          description: Trimmed button label, at most80bytes.
          type: string
          maxLength: 80
          example: Sponsor now
        disable_program_link:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        enable_public_add_entity_search:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_info:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_percent:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_sponsorship_amount:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_recipients_bio:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_waiting_time:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        display_all:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        descending_order:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        enable_featured_recipients:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        least_funded_first:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        hide_noimage_recipients:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        blur_recipients:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        placeholder:
          description: >-
            Supported launch setting. Scalar values are trimmed and limited
            to500bytes.
          type: string
          maxLength: 500
          example: ''
          nullable: true
        remove_amounts:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        allow_custom_sponsorship_amounts:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        designations:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        allow_donor_additional_gift_designation_choice:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        disable_multiple_designations:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        stripe:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        checks:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        cash:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        wire_transfer:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        hide_payment_method:
          description: hidden/enabled values hide the control; other values clear hiding.
          oneOf:
            - type: string
              example: hidden
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: array
              items:
                type: string
                example: '1'
        hide_frequency:
          description: hidden/enabled values hide the control; other values clear hiding.
          oneOf:
            - type: string
              example: hidden
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: array
              items:
                type: string
                example: '1'
        processing_fee:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        select_processing_fee:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        processing_percentage:
          description: Blank or numeric percentage from0through100; stored as text.
          oneOf:
            - type: string
              example: '3'
            - type: number
              maximum: 100
              minimum: 0
              example: 3
        display_in_honor_of:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        allow_start_date:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        login_box:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_enabled:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_view_donors:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_view_donations:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_view_donation_amounts:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_show_donor_names:
          description: Trimmed donor-name visibility setting, at most64bytes.
          type: string
          maxLength: 64
          example: first_name
        recipient_portal_public_fundraising_page:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_edit_profile:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_message_donors:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        recipient_portal_message_requires_approval:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        show_donation_amounts:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        show_donor_names:
          description: Trimmed donor-name visibility setting, at most64bytes.
          type: string
          maxLength: 64
          example: first_name
        allow_recurring_donations:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        completed_accept_donations:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
        default_amount:
          description: >-
            Must match one configured transaction_amount entry for
            campaign/peer_to_peer, or be blank.
          type: string
          example: '25'
        default_frequency:
          description: Checkout default frequency.
          type: string
          enum:
            - ''
            - one_time
            - recurring
          example: one_time
        show_payment:
          description: >-
            Enabled by true,1,string1/true/on/yes or a list containing an
            enabled value; stored as string0/string1.
          oneOf:
            - type: boolean
              example: true
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: array
              items:
                type: string
                example: '1'
      type: object
      additionalProperties: false
    ProgramLaunchContext:
      properties:
        program:
          properties:
            id:
              type: integer
              example: 42
            client_id:
              type: integer
              example: 12
            name:
              type: string
              example: Education
            prefix:
              type: string
              nullable: true
            setting_id:
              type: integer
              nullable: true
            program_type:
              type: string
              nullable: true
            program_type_label:
              type: string
              example: Number of Sponsors
          type: object
        readiness:
          allOf:
            - $ref: '#/components/schemas/ProgramSetupState'
            - properties:
                completion:
                  properties:
                    complete:
                      type: integer
                      example: 5
                    required:
                      type: integer
                      example: 7
                  type: object
              type: object
        setting:
          properties:
            id:
              type: integer
              nullable: true
            name:
              type: string
              nullable: true
            linked_programs_count:
              type: integer
              example: 1
            linked_programs:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  name:
                    type: string
                    example: Education
                  prefix:
                    type: string
                    example: EDU
                    nullable: true
                type: object
            is_shared:
              type: boolean
              example: false
            can_manage:
              type: boolean
              example: true
            advanced_url:
              type: string
              example: /app/program-settings
            copy_on_save_default:
              type: boolean
              example: false
          type: object
        branding:
          properties:
            attribution_removed:
              type: boolean
              example: false
          type: object
        visual_settings:
          description: >-
            Saved launch options use legacy scalar/JSON encodings;
            payment_methods contains card/check/cash/wire_transfer booleans.
          type: object
          additionalProperties: true
        preview:
          properties:
            color_theme:
              required:
                - color
                - color_level
              properties:
                color:
                  type: string
                  example: indigo
                color_level:
                  type: integer
                  example: 600
              type: object
            organization_color_theme:
              required:
                - color
                - color_level
              properties:
                color:
                  type: string
                  example: indigo
                color_level:
                  type: integer
                  example: 600
              type: object
            check_payment_instructions:
              type: string
              example: Mail checks to the organization.
          type: object
        additional_gift_routing:
          $ref: '#/components/schemas/ProgramAdditionalGiftRouting'
        public_links:
          properties:
            base_url:
              type: string
              example: https://app.gratona.com
            primary_url:
              type: string
              nullable: true
            items:
              type: array
              items:
                properties:
                  key:
                    type: string
                    example: donation_page
                  label:
                    type: string
                    example: Donation Page
                  url:
                    type: string
                  description:
                    type: string
                type: object
            donor_login:
              type: string
            program_login:
              type: string
            recipient_portal_login:
              type: string
              nullable: true
          type: object
        embed:
          properties:
            smart:
              properties:
                recommended:
                  type: boolean
                  example: true
                config:
                  properties:
                    type:
                      type: string
                      enum:
                        - trip
                        - donation
                        - peer-to-peer
                        - sponsorship
                      example: sponsorship
                    clientId:
                      type: string
                      example: '12'
                    programId:
                      type: string
                      example: '42'
                    programSlug:
                      type: string
                      nullable: true
                    tripSlug:
                      type: string
                    baseUrl:
                      type: string
                      example: https://app.gratona.com
                    defaultAmount:
                      nullable: true
                    defaultFrequency:
                      type: string
                      nullable: true
                  type: object
                  nullable: true
                preview_url:
                  type: string
                  nullable: true
              type: object
          type: object
      type: object
    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
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    ProgramSetupState:
      properties:
        program_id:
          type: integer
          example: 42
        program_name:
          type: string
          example: Education
        program_type:
          type: string
          enum:
            - number
            - contribution
            - campaign
            - peer_to_peer
            - trips
            - null
          example: number
          nullable: true
        program_type_label:
          type: string
          example: Number of Sponsors
        attached_modules:
          properties:
            settings_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            donor_hysform_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            hysform_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            emailset_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            smsset_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
          type: object
        email_required:
          type: boolean
          example: true
        steps:
          type: array
          items:
            properties:
              key:
                type: string
                example: donor_form
              label:
                type: string
                example: Donor form
              state:
                type: string
                enum:
                  - complete
                  - missing
                  - optional
                  - blocked
                example: complete
              next_action:
                type: string
                example: Attach a donor form
                nullable: true
            type: object
        next_step_key:
          type: string
          example: entity_form
          nullable: true
        is_launch_ready:
          type: boolean
          example: false
      type: object
    ProgramAdditionalGiftRouting:
      properties:
        allow_donor_choice:
          type: boolean
          example: true
        available_gifts:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              name:
                type: string
                example: School supplies
              code:
                type: string
                example: SUPPLIES
                nullable: true
            type: object
        target_entities:
          type: array
          items:
            $ref: '#/components/schemas/ProgramGiftTarget'
        target_entities_exist:
          type: boolean
          example: true
        routes:
          description: >-
            Gift designation ID to default recipient ID, or an empty list when
            no routes exist.
          oneOf:
            - type: object
              additionalProperties:
                type: integer
                nullable: true
            - type: array
              items: {}
              maxItems: 0
      type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      type: object
    ProgramGiftTarget:
      properties:
        id:
          type: integer
          example: 42
        name:
          type: string
          example: Education fund
        program_id:
          type: integer
          example: 12
      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.