> ## 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 a designation-only checkout frequency

> Updates the Redis checkout cart frequency for a designation-only gift. The public checkout UI calls this when a donor changes a selected designation from one-time to a recurring schedule. If the optional session id is absent or expired, the controller creates a new frontend session before writing the `saved_designation_frequency` hash.



## OpenAPI

````yaml get /frontend/checkout_update_designation_frequency_only/{client_id}/{hysform_id}/{designation_id}/{id}/{frequency}/{session_id}
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:
  /frontend/checkout_update_designation_frequency_only/{client_id}/{hysform_id}/{designation_id}/{id}/{frequency}/{session_id}:
    get:
      tags:
        - Public
      summary: Update a designation-only checkout frequency
      description: >-
        Updates the Redis checkout cart frequency for a designation-only gift.
        The public checkout UI calls this when a donor changes a selected
        designation from one-time to a recurring schedule. If the optional
        session id is absent or expired, the controller creates a new frontend
        session before writing the `saved_designation_frequency` hash.
      operationId: checkoutUpdateDesignationOnlyFrequency
      parameters:
        - name: client_id
          in: path
          description: >-
            Client id that owns the designation. The controller uses it when
            loading the designation name for the confirmation message.
          required: true
          schema:
            type: integer
          example: 207
        - name: hysform_id
          in: path
          description: >-
            Donor HysForm id for this designation-only checkout page. It is
            carried through the route for checkout context.
          required: true
          schema:
            type: integer
          example: 42
        - name: designation_id
          in: path
          description: >-
            Configured designation checkout id from the landing page. It scopes
            the designation-only checkout context.
          required: true
          schema:
            type: string
          example: all
        - name: id
          in: path
          description: >-
            Specific designation id already in the Redis cart. This key is
            updated in `saved_designation_frequency`.
          required: true
          schema:
            type: integer
          example: 88
        - name: frequency
          in: path
          description: >-
            Frequency code selected by the donor. The controller stores the code
            and uses `Donor::getFrequency()` for the human-readable message.
          required: true
          schema:
            type: integer
          example: 5
        - name: session_id
          in: path
          description: >-
            Optional Redis frontend session id. When it is missing or expired,
            the endpoint creates a replacement session before saving the
            frequency.
          required: true
          schema:
            type: string
          example: 7f2c8f8d64b8a1d4a9e2
      responses:
        '200':
          description: Designation frequency was updated in the checkout session.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Schedule for General Fund was changed to Monthly
                  status:
                    type: string
                    example: success
                type: object
        '404':
          description: The donor form or selected client-owned record was not found.
      security: []

````

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