> ## 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. # Queue bulk fundraising gift acknowledgement > Returns202 with a durable operation receipt. Supply donation_ids, or select_all_matching=true with validated transaction filters. Selection is restricted to readable unacknowledged gifts and excludes Do Not Acknowledge. Poll status_url for completion; queue acceptance does not imply gifts are already updated. Requires permission: one of donations. ## OpenAPI ````yaml post /admin/donations/acknowledge 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/donations/acknowledge: post: tags: - Fundraising summary: Queue bulk fundraising gift acknowledgement description: >- Returns202 with a durable operation receipt. Supply donation_ids, or select_all_matching=true with validated transaction filters. Selection is restricted to readable unacknowledged gifts and excludes Do Not Acknowledge. Poll status_url for completion; queue acceptance does not imply gifts are already updated. Requires permission: one of donations. operationId: fundraisingHubAcknowledgeDonations requestBody: description: Validated request fields for this operation. required: false content: application/json: schema: properties: donation_ids: description: >- Required when select_all_matching is false or omitted; readable gift ids. type: array items: description: 'Donation ids item. Validation: integer.' type: integer example: 1 minItems: 1 select_all_matching: description: 'Select all matching. Validation: nullable, boolean.' type: boolean example: true nullable: true filters: description: >- Required when select_all_matching is true; uses the transaction filter contract. Pagination is ignored. properties: acknowledgement_work_scope: description: >- Acknowledgement work scope. Validation: nullable; allowed values: active, historical, all. type: string enum: - active - historical - all - null example: active nullable: true fundraiser_user_id: description: >- Fundraiser user id. Validation: nullable, string, max:64. type: string maxLength: 64 example: all nullable: true group_by_household: description: 'Group by household. Validation: nullable.' type: string example: Group By Household nullable: true search: description: 'Search. Validation: nullable, string, max:255.' type: string maxLength: 255 example: education nullable: true date_from: description: 'Date from. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true date_to: description: 'Date to. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true state: description: 'State. Validation: nullable, string, max:64.' type: string maxLength: 64 example: State nullable: true comparison_mode: description: 'Comparison mode. Validation: nullable, string, max:64.' type: string maxLength: 64 example: Comparison Mode nullable: true current_start: description: 'Current start. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true current_end: description: 'Current end. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true comparison_start: description: 'Comparison start. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true comparison_end: description: 'Comparison end. Validation: nullable, date.' type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true refresh: description: >- Refresh cached fundraising overview calculations; accepts boolean, numeric0/1 and their string forms. oneOf: - type: boolean example: true - type: integer enum: - 0 - 1 example: 1 - type: string enum: - '0' - '1' - 'true' - 'false' example: 'true' - type: string enum: - null nullable: true page: description: 'Page. Validation: nullable, integer, min:1.' type: integer minimum: 1 example: 1 nullable: true per_page: description: >- Per page. Validation: nullable, integer, min:10, max:100. type: integer maximum: 100 minimum: 10 example: 10 nullable: true donor_id: description: 'Donor id. Validation: nullable, integer.' type: integer example: 1 nullable: true method: description: 'Method. Validation: nullable, string, max:64.' type: string maxLength: 64 example: Method nullable: true acknowledgement_status: description: >- Acknowledgement status. Validation: nullable; allowed values: all, acknowledged, unacknowledged. type: string enum: - all - acknowledged - unacknowledged - null example: all nullable: true acknowledgement_scope: description: >- Acknowledgement scope. Validation: nullable; allowed values: period, backlog. type: string enum: - period - backlog - null example: period nullable: true status_scope: description: >- Status scope. Validation: nullable; allowed values: qualified, exceptions, all. type: string enum: - qualified - exceptions - all - null example: qualified nullable: true sort_field: description: >- Sort field. Validation: nullable; allowed values: date, amount. type: string enum: - date - amount - null example: date nullable: true sort_direction: description: >- Sort direction. Validation: nullable; allowed values: asc, desc. type: string enum: - asc - desc - null example: asc nullable: true type: object source: description: 'Source. Validation: nullable, string, max:64.' type: string maxLength: 64 example: Source nullable: true note: description: 'Note. Validation: nullable, string, max:1000.' type: string maxLength: 1000 example: Discuss the next update with the program team. nullable: true type: object responses: '202': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: $ref: '#/components/schemas/FundraisingHubBulkAcknowledgement' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The authenticated user lacks access to this workflow or its related records. '422': description: >- Request, policy, source relationship, lifecycle or selection validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: FundraisingHubBulkAcknowledgement: description: >- Accepted queue receipt, not proof gifts have been acknowledged. An empty selection may already be completed. properties: bulk_operation: properties: operation_id: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 type: description: Serialized value. type: string example: Example nullable: true status: description: Serialized value. type: string example: Example nullable: true total_items: description: Count. type: integer example: 2 nullable: false processed_items: description: Count. type: integer example: 2 nullable: false failed_items: description: Count. type: integer example: 2 nullable: false skipped_items: description: Count. type: integer example: 2 nullable: false updated_items: description: Count. type: integer example: 2 nullable: false progress_percent: description: Amount or percentage. type: number example: 25 nullable: false message: description: Serialized value. type: string example: Example nullable: true created_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true completed_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true stalled: description: Workflow state. type: boolean example: true failed_record_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false has_failed_records: description: Workflow state. type: boolean example: true skipped_reasons: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} context: description: Null for gift acknowledgement operations. nullable: true type: object status_url: description: Relative operation polling URL returned by this legacy API. type: string example: >- /api/v1/admin/bulk-edit-operations/550e8400-e29b-41d4-a716-446655440000 type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error 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 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 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.