> ## 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. # Review a donor sponsorship change > Creates a ten-minute, session-bound one-time review without writing the payment schedule. Only the documented properties are accepted. Change preserves the monthly-equivalent contribution and re-expresses a per-period amount for the selected frequency; cancellation preserves historical payments/paid coverage. The review explains direct application or approval consequences. Online writes require direct/approval program mode and workspace rollout. A pending request blocks additional changes. Provider subscriptions, nonbilling/zero/nonrecurring commitments, expired schedules or processing payments require staff help; cancellation also requires active donor_cancelled reason with no notes. Schedule changes also block due/past-due/retry payments. Uses a logged-in donor session for this organization and a valid portal program/global context; the session TTL refreshes to one hour. Only that donor’s relationships or requests can be accessed. ## OpenAPI ````yaml post /frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview 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: /frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview: post: tags: - Sponsorships summary: Review a donor sponsorship change description: >- Creates a ten-minute, session-bound one-time review without writing the payment schedule. Only the documented properties are accepted. Change preserves the monthly-equivalent contribution and re-expresses a per-period amount for the selected frequency; cancellation preserves historical payments/paid coverage. The review explains direct application or approval consequences. Online writes require direct/approval program mode and workspace rollout. A pending request blocks additional changes. Provider subscriptions, nonbilling/zero/nonrecurring commitments, expired schedules or processing payments require staff help; cancellation also requires active donor_cancelled reason with no notes. Schedule changes also block due/past-due/retry payments. Uses a logged-in donor session for this organization and a valid portal program/global context; the session TTL refreshes to one hour. Only that donor’s relationships or requests can be accessed. operationId: DonorSponsorshipManagementController_preview parameters: - name: client_id in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 - name: program_id in: path description: Owned portal program ID or none for the organization-wide portal. required: true schema: type: string example: none example: none - name: session_id in: path description: >- Logged-in donor session token for the requested organization; refreshed to one hour. required: true schema: type: string example: donor-session-token example: donor-session-token - name: donor_entity_id in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 requestBody: required: true content: application/json: schema: oneOf: - required: - action - frequency - next_action_date properties: action: description: Review frequency/next-date change. type: string enum: - change example: change frequency: description: >- Choose from frequencies returned by sponsorship detail; biweekly6 supports date-only changes. type: integer enum: - 1 - 2 - 3 - 4 - 6 - 7 example: 1 next_action_date: description: Date inside the detail response window. type: string format: date example: '2026-12-01' type: object additionalProperties: false - required: - action properties: action: description: Review cancellation; frequency/date are prohibited. type: string enum: - cancel example: cancel type: object additionalProperties: false responses: '200': description: Review a donor sponsorship change completed. content: application/json: schema: properties: status: description: Operation success. type: string enum: - success example: success data: $ref: '#/components/schemas/SponsorshipApiManagementPreview' type: object '401': description: Session expired or invalid program/donor context. content: application/json: schema: $ref: '#/components/schemas/SponsorshipApiManagementError' '404': description: Relationship/request is absent from the donor account. content: application/json: schema: $ref: '#/components/schemas/SponsorshipApiManagementError' '409': description: An approval request is already pending. content: application/json: schema: $ref: '#/components/schemas/SponsorshipApiManagementError' '422': description: >- Unexpected/invalid fields, unavailable frequency/date, unchanged schedule or current action blocker. content: application/json: schema: oneOf: - $ref: '#/components/schemas/SponsorshipApiManagementError' - $ref: '#/components/schemas/ValidationErrorResponse' security: [] components: schemas: SponsorshipApiManagementPreview: properties: action: description: Requested schedule change or cancellation. type: string enum: - change - cancel example: change management_mode: description: >- Effective mode from sponsorship program settings and workspace rollout. type: string enum: - disabled - direct - approval example: disabled donor_entity_id: description: Owned relationship ID. type: integer example: 42 commitment_id: description: Commitment being reviewed. type: integer example: 42 current: $ref: '#/components/schemas/SponsorshipApiFinancialState' projected: $ref: '#/components/schemas/SponsorshipApiFinancialState' currency_symbol: description: Currency symbol. type: string example: Example nullable: true payment_behavior: description: Billing behavior derived from stored payment method. type: string enum: - automatic_charge - manual_reminder - external_processor - non_billing example: automatic_charge preview_token: description: >- One-time review UUID, bound to organization/donor/session/program/sponsorship/action/values/state. type: string format: uuid example: d38103d8-1e8b-47ab-ae04-7e1f8a3bc727 preview_expires_at: description: Review expires after ten minutes. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true message: description: Change/cancel and direct/approval consequences. type: string example: >- Confirming updates your future payment schedule. You will not be charged now. paid_through_date: description: Paid coverage is retained. type: string format: date example: '2026-11-01' 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 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 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.