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

# Set the default worksheet saved view

> Module path accepts recipients, campaigns, sponsorships or donations. Preference belongs to the authenticated user and organization. Only active saved view/report definitions in a valid existing context are eligible; current context permission is checked. Campaign and recipient surfaces remain separate. Replaces this user’s default with an accessible definition, including legacy donor definitions. Returns 404 when the saved definition is unavailable.



## OpenAPI

````yaml put /admin/saved-view-defaults/{module}
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/saved-view-defaults/{module}:
    put:
      tags:
        - Donors
      summary: Set the default worksheet saved view
      description: >-
        Module path accepts recipients, campaigns, sponsorships or donations.
        Preference belongs to the authenticated user and organization. Only
        active saved view/report definitions in a valid existing context are
        eligible; current context permission is checked. Campaign and recipient
        surfaces remain separate. Replaces this user’s default with an
        accessible definition, including legacy donor definitions. Returns 404
        when the saved definition is unavailable.
      operationId: WorksheetSavedViewDefaultController_update
      parameters:
        - name: module
          in: path
          description: Worksheet surface; campaign and recipient defaults are separate.
          required: true
          schema:
            type: string
            enum:
              - recipients
              - campaigns
              - sponsorships
              - donations
            example: recipients
          example: recipients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - filter_preference_id
              properties:
                filter_preference_id:
                  description: Eligible saved view/report definition ID.
                  type: integer
                  minimum: 1
                  example: 42
              type: object
      responses:
        '200':
          description: Set the default worksheet saved view completed.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Confirmation.
                    type: string
                    example: Default worksheet view updated.
                  data:
                    $ref: '#/components/schemas/CrmApiSavedViewRecord'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission or feature access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Saved definition/module is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CrmApiSavedViewRecord:
      properties:
        id:
          description: Saved view/report ID.
          type: integer
          example: 42
        client_id:
          description: Organization ID.
          type: integer
          example: 42
        owner_user_id:
          description: Saved definition owner.
          type: integer
          example: 42
          nullable: true
        hysform_id:
          description: Form/program context; zero is the all-records context.
          type: integer
          example: 42
        module_id:
          description: >-
            Module ID: donors 1, recipients/campaigns 2, sponsorships 3,
            donations 4; null is legacy donors.
          type: integer
          example: 42
          nullable: true
        sponsorships:
          description: Saved sponsorship scope.
          type: integer
          example: 42
          nullable: true
        name:
          description: Saved definition label.
          type: string
          example: Example
          nullable: true
        fields:
          description: Raw stored JSON string for fields.
          type: string
          example: '[]'
          nullable: true
        column_fields:
          description: Raw stored JSON string for column fields.
          type: string
          example: '[]'
          nullable: true
        column_order:
          description: Raw stored JSON string for column order.
          type: string
          example: '[]'
          nullable: true
        date_range:
          description: Raw stored JSON string for date range.
          type: string
          example: '[]'
          nullable: true
        footer_calculations:
          description: Raw stored JSON string for footer calculations.
          type: string
          example: '[]'
          nullable: true
        sort_key:
          description: Saved sort key.
          type: string
          example: Example
          nullable: true
        sort_order:
          description: Saved direction.
          type: string
          example: Example
          nullable: true
        search_query:
          description: Saved search text.
          type: string
          example: Example
          nullable: true
        related_config:
          description: >-
            Related worksheet configuration; decoded object/list for direct
            saved-view writes, or encoded JSON string through legacy report
            catalog writes. May contain program_surface.
          oneOf:
            - type: object
              additionalProperties: true
            - type: array
              items:
                type: string
            - type: string
              example: '{}'
            - type: string
              enum:
                - null
              nullable: true
        snapshot:
          description: Whether the definition is a snapshot.
          type: boolean
          example: false
        type:
          description: view/report or legacy null/empty.
          type: string
          example: Example
          nullable: true
        created_at:
          description: Created.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          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
    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
  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.