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

# Approve a donor sponsorship change request

> Rechecks a still-pending request under billing/row locks and applies exactly its reviewed values. Changed ownership/financial fingerprint, changed management mode or an unavailable schedule leave the request pending. Schedule changes require donation management permission; cancellation honors the role archive restriction. Approval never charges or refunds; cancellation keeps past giving/paid coverage. Requests are scoped to this organization and programs accessible to the reviewer. Snapshot financial details require donation read access.



## OpenAPI

````yaml post /admin/sponsorship-change-requests/{request_id}/approve
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/sponsorship-change-requests/{request_id}/approve:
    post:
      tags:
        - Sponsorships
      summary: Approve a donor sponsorship change request
      description: >-
        Rechecks a still-pending request under billing/row locks and applies
        exactly its reviewed values. Changed ownership/financial fingerprint,
        changed management mode or an unavailable schedule leave the request
        pending. Schedule changes require donation management permission;
        cancellation honors the role archive restriction. Approval never charges
        or refunds; cancellation keeps past giving/paid coverage. Requests are
        scoped to this organization and programs accessible to the reviewer.
        Snapshot financial details require donation read access.
      operationId: SponsorshipChangeRequestController_approve
      parameters:
        - name: request_id
          in: path
          description: Record ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
      responses:
        '200':
          description: Approve a donor sponsorship change request completed.
          content:
            application/json:
              schema:
                properties:
                  status:
                    description: Operation success.
                    type: string
                    enum:
                      - success
                    example: success
                  message:
                    description: Approval result.
                    type: string
                    example: >-
                      Request approved. The payment schedule was updated without
                      a charge.
                  data:
                    $ref: '#/components/schemas/SponsorshipApiReviewedRequest'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Reviewer cannot manage donation schedules or archive sponsorships.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorshipApiManagementError'
        '404':
          description: Request/setting is absent from the accessible organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorshipApiManagementError'
        '409':
          description: >-
            Resolved/stale request, paused/changed mode, or payment lock
            conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorshipApiManagementError'
        '422':
          description: >-
            Current program schedule/payment/cancellation policy blocks the
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SponsorshipApiManagementError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    SponsorshipApiReviewedRequest:
      type: object
      allOf:
        - $ref: '#/components/schemas/SponsorshipApiChangeRequest'
        - properties:
            can_approve:
              description: Pending and currently eligible for reviewer approval.
              type: boolean
              example: false
            blocked_reason:
              description: Current approval blocker; null when eligible.
              type: string
              example: Example
              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
    SponsorshipApiManagementError:
      required:
        - status
        - code
        - message
      properties:
        status:
          description: Failure status.
          type: string
          enum:
            - error
          example: error
        code:
          description: Stable domain/session rejection code.
          type: string
          example: preview_stale
        message:
          description: Readable explanation.
          type: string
          example: Review the latest sponsorship details again.
      type: object
    SponsorshipApiChangeRequest:
      properties:
        id:
          description: Id.
          type: integer
          example: 42
        donor_entity_id:
          description: Donor entity id.
          type: integer
          example: 42
        commitment_id:
          description: Commitment id.
          type: integer
          example: 42
        program_id:
          description: Program id.
          type: integer
          example: 42
        status:
          description: Durable request status.
          type: string
          enum:
            - pending
            - approved
            - rejected
            - withdrawn
          example: pending
        action:
          description: Requested schedule change or cancellation.
          type: string
          enum:
            - change
            - cancel
          example: change
        program_name:
          description: Program name.
          type: string
          example: Example
          nullable: true
        donor_name:
          description: Donor name.
          type: string
          example: Example
          nullable: true
        recipient_name:
          description: Recipient name.
          type: string
          example: Example
          nullable: true
        review_note:
          description: Review note.
          type: string
          example: Example
          nullable: true
        currency_symbol:
          description: Currency symbol.
          type: string
          example: Example
          nullable: true
        created_at:
          description: Request creation time.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        reviewed_at:
          description: Staff review time.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        current:
          oneOf:
            - $ref: '#/components/schemas/SponsorshipApiFinancialState'
            - type: string
              enum:
                - null
              nullable: true
        projected:
          oneOf:
            - $ref: '#/components/schemas/SponsorshipApiFinancialState'
            - type: string
              enum:
                - null
              nullable: true
        payment_behavior:
          description: Billing behavior derived from stored payment method.
          type: string
          enum:
            - automatic_charge
            - manual_reminder
            - external_processor
            - non_billing
            - null
          example: automatic_charge
          nullable: true
      type: object
    SponsorshipApiFinancialState:
      properties:
        raw_amount:
          description: Stored amount rounded to two decimals.
          type: number
          example: 25
        per_period_charge:
          description: Charge/reminder amount for each period.
          type: number
          example: 25
        monthly_equivalent:
          description: Monthly-equivalent contribution.
          type: number
          example: 25
        frequency:
          description: >-
            Frequency code: 1 monthly,2 quarterly,3 semiannual,4 annual,6
            biweekly,7 bimonthly.
          type: integer
          example: 1
        amount_basis:
          description: >-
            Stored amount applies to each billing period when true, monthly
            equivalent otherwise.
          type: boolean
          example: false
        method:
          description: Stored payment method code.
          type: integer
          example: 3
        next_action_date:
          description: Explicit next occurrence, nullable.
          type: string
          format: date
          example: '2026-11-01'
          nullable: true
        end_date:
          description: Schedule end, nullable.
          type: string
          format: date
          example: '2026-11-01'
          nullable: true
      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.