> ## 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 bulk commitment changes > Resolves explicit, all-program/filtered or complete failed-operation sponsorship selections and projects financial outcomes. Every relationship must have a matching active donor, recipient, commitment and any nonzero program in this organization; inaccessible owned programs fail403. selected_rows is limited to100; all_total/failed_operation can span the full selection and return grouped outcomes with items empty. No commitment is changed or charged. Apply through PATCH /admin/commitments using the returned ten-minute token and identical selection/values. ## OpenAPI ````yaml post /admin/commitments/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/commitments/preview: post: tags: - Sponsorships summary: Review bulk commitment changes description: >- Resolves explicit, all-program/filtered or complete failed-operation sponsorship selections and projects financial outcomes. Every relationship must have a matching active donor, recipient, commitment and any nonzero program in this organization; inaccessible owned programs fail403. selected_rows is limited to100; all_total/failed_operation can span the full selection and return grouped outcomes with items empty. No commitment is changed or charged. Apply through PATCH /admin/commitments using the returned ten-minute token and identical selection/values. operationId: CommitmentController_previewEditCommitments requestBody: required: true content: application/json: schema: required: - values properties: donor_entity_ids: description: >- Required unless retrying failed_operation. Positive relationship ID list, or exact all string for program/filter scope. oneOf: - type: array items: description: Selected sponsorship relationship ID. type: integer minimum: 1 example: 42 - description: Select full program/filter scope. type: string enum: - all example: all selection_mode: description: >- Default selected_rows; all_total and failed_operation return grouped outcomes without per-row enumeration. type: string enum: - selected_rows - all_total - failed_operation - null example: selected_rows nullable: true failed_operation_id: description: >- Required for failed_operation; complete failed commitment scope from a previous tracked operation. type: string format: uuid example: d38103d8-1e8b-47ab-ae04-7e1f8a3bc727 nullable: true selected_count: description: UI selection count, accepted as a hint. type: integer minimum: 1 example: 2 nullable: true program_id: description: >- Effective sponsorship program scope for all selection, or all programs. example: all oneOf: - type: integer minimum: 1 - type: string enum: - all pageIndex: description: >- Worksheet compatibility input; full filtered selection is collected across pages. type: integer minimum: 1 example: 1 nullable: true pageSize: description: >- Worksheet compatibility input; resolver collects pages of250. type: integer minimum: 1 example: 25 nullable: true sortOrder: description: Worksheet sorting direction. type: string example: Example nullable: true sortKey: description: Worksheet sorting key. type: string example: Example nullable: true query: description: Worksheet search query. type: string example: Example nullable: true filter: description: >- Archived selector as boolean/numeric/string; unavailable archived commitments fail completeness checks. example: 'false' status: description: Supported worksheet status view. type: string enum: - current - due - null example: current nullable: true filterGroups: type: array items: $ref: '#/components/schemas/AdminWorksheetFilterGroup' nullable: true savedFilterId: description: Owned saved sponsorship worksheet definition to resolve. example: 42 nullable: true fields: description: >- Worksheet-selected field keys or supported legacy encoded columns. oneOf: - type: array items: description: Worksheet field key. type: string example: donor_name - type: string example: '[]' - type: string enum: - null nullable: true column_order: type: array items: description: Worksheet key order. type: string example: donor_name nullable: true preview_token: description: >- Optional ignored preview compatibility input; a fresh token is returned. type: string format: uuid example: d38103d8-1e8b-47ab-ae04-7e1f8a3bc727 nullable: true values: description: >- At least one supported commitment field; preview projects financial fields without writing. minProperties: 1 properties: frequency: description: New billing frequency. type: integer enum: - 1 - 2 - 3 - 4 - 6 - 7 example: 1 until: description: End date in YYYY-MM-DD, or 0000-00-00 for no end. type: string example: '2027-12-31' next: description: New next payment date. type: string format: date example: '2026-12-01' method: description: New payment method code. type: integer maximum: 13 minimum: 1 example: 3 amount: description: >- New stored amount; frequency/basis determine the actual period charge. type: number minimum: 0 example: 25 is_per_period_amount: description: 'New amount basis: true per period, false monthly.' type: boolean example: false arb_subscription_id: description: >- Legacy external subscription identifier; null clears to empty. type: string example: Example nullable: true program_id: description: Destination program when subsequently applying changes. type: integer minimum: 1 example: 42 type: object additionalProperties: false type: object responses: '200': description: Review bulk commitment changes completed. content: application/json: schema: properties: data: $ref: '#/components/schemas/SponsorshipApiBulkCommitmentPreview' 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 selection, incomplete commitment, failed retry scope, oversized selected_rows or invalid values. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: AdminWorksheetFilterGroup: required: - field - operator properties: field: description: >- System or tenant form field key allowed in the current module/program. type: string example: display_name operator: description: >- Field-compatible comparison, for example equals, notEquals, contains, startsWith, isUnknown, hasAnyValue, isEmpty, greater_than or less_than. Date/age/relationship fields use their field-specific supported operators. type: string example: contains value: description: >- Comparison value. Required except presence/empty operators; scalar, list or field-specific structured date/relationship value. logicalOperator: description: >- Join this valid group to the following group; defaults to AND. Additional field metadata may be passed for typed date and custom-field comparisons. type: string enum: - AND - OR example: AND type: object additionalProperties: {} SponsorshipApiBulkCommitmentPreview: properties: total_items: description: Matching complete active relationships. type: integer example: 42 selection_mode: description: Resolved selection mode. type: string enum: - selected_rows - all_total - failed_operation example: selected_rows items: description: Enumerated only for selected_rows. type: array items: properties: donor_entity_id: description: Selected relationship. type: integer example: 42 commitment_id: description: Current commitment. type: integer example: 42 donor_name: description: Donor display name. type: string example: Jane Doe recipient_name: description: Recipient display name. type: string example: John Doe program_name: description: Effective program label. type: string example: Education currency_symbol: description: Currency symbol. type: string example: Example nullable: true current: $ref: '#/components/schemas/SponsorshipApiFinancialState' projected: $ref: '#/components/schemas/SponsorshipApiFinancialState' type: object items_truncated: description: Always false; grouped selections intentionally omit items. type: boolean example: false outcome_groups: description: Groups include every selected relationship. type: array items: properties: count: description: >- Relationships sharing identical current/projected financial state. type: integer example: 42 currency_symbol: description: Currency symbol. type: string example: Example nullable: true current: $ref: '#/components/schemas/SponsorshipApiFinancialState' projected: $ref: '#/components/schemas/SponsorshipApiFinancialState' type: object preview_token: description: >- Single-use review token for the matching bulk PATCH selection/values, bound to this organization/admin and financial fingerprints. type: string format: uuid example: d38103d8-1e8b-47ab-ae04-7e1f8a3bc727 preview_expires_at: description: Token expires after ten minutes. type: string format: date-time example: '2026-10-20T12:10:00Z' 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 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 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 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.