> ## 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. # Preview available fixed sponsorship levels > Uses supplied configuration only; no program or recipient is changed. Filters configured positive amounts by current funded percentage and remaining capacity. An amount remains available only below its configured threshold (default100); exceeding remaining target requires allow_sponsorship_over_target. funded_percent is rounded to two decimals and can exceed100. ## OpenAPI ````yaml post /admin/sponsorship-amount-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: /admin/sponsorship-amount-preview: post: tags: - Sponsorships summary: Preview available fixed sponsorship levels description: >- Uses supplied configuration only; no program or recipient is changed. Filters configured positive amounts by current funded percentage and remaining capacity. An amount remains available only below its configured threshold (default100); exceeding remaining target requires allow_sponsorship_over_target. funded_percent is rounded to two decimals and can exceed100. operationId: SponsorshipAmountPreviewController___invoke requestBody: required: true content: application/json: schema: required: - target - funded - settings properties: target: description: Total monthly target. type: number maximum: 1000000000 minimum: 0.01 example: 100 funded: description: Already funded monthly amount. type: number maximum: 1000000000 minimum: 0 example: 25 settings: required: - sponsorship_amount - sponsorship_amount_mode - sponsorship_level_thresholds - allow_sponsorship_over_target - allow_custom_sponsorship_amounts properties: sponsorship_amount: description: Comma-separated configured level amounts. type: string maxLength: 2000 example: 25,50 labels: description: >- Optional comma-separated labels aligned to the amount list; mismatched count leaves amounts unlabelled. type: string maxLength: 5000 example: Education,Full support nullable: true sponsorship_amount_mode: description: Only fixed level contribution previews are supported. type: string enum: - fixed_levels example: fixed_levels sponsorship_level_thresholds: description: >- Encoded JSON object with at most100 amount keys; keys must be positive amounts to two decimals and values percentages greater than0 up to100. type: string maxLength: 10000 example: '{}' allow_sponsorship_over_target: description: Allow an offered level to exceed the remaining target. type: string enum: - '0' - '1' example: '0' allow_custom_sponsorship_amounts: description: Permit custom amounts while at least0.01 remains. type: string enum: - '0' - '1' example: '0' type: object additionalProperties: false type: object responses: '200': description: Preview available fixed sponsorship levels completed. content: application/json: schema: properties: amount_options: type: array items: description: Available amount and optional aligned label. type: string example: 25 Education allows_custom_amounts: description: Custom input enabled and target minus funded at least0.01. type: boolean example: false funded_percent: description: Funded divided by target as percentage. type: number example: 25 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' '422': description: Invalid target/funding or level configuration. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: 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 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 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 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.