> ## 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. # Start a batch import for donors or recipients ## OpenAPI ````yaml post /admin/import/donors-recipients/batch 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 sponsorship relationships, lifecycle transitions, and sponsorship-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: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /admin/import/donors-recipients/batch: post: tags: - Files summary: Start a batch import for donors or recipients operationId: 60345557fbf1e5a45051f5f654d00a3e requestBody: required: true content: application/json: schema: properties: filename: description: S3 filename of the CSV type: string original_filename: description: Original uploaded filename type: string import_type: description: Type of import (donors or recipients) type: string fields: description: Mapping of CSV columns to field keys type: object household: description: Enable household feature type: boolean householdColumn: description: Household column name type: string householdNameColumn: description: Household name column name type: string householdAddress1Column: description: Household address1 column name type: string householdAddress2Column: description: Household address2 column name type: string householdCityColumn: description: Household city column name type: string householdStateColumn: description: Household state column name type: string householdZipColumn: description: Household zip column name type: string householdCountryColumn: description: Household country column name type: string householdPrimaryColumn: description: Household primary column name type: string householdRelationColumn: description: Household relation column name type: string hysCustomid: description: Household custom ID field type: array items: type: string notify_donor: description: Notify donor type: boolean notify_donor_template_id: description: Notify donor template ID type: integer sp_amount: description: Sponsorship amount type: string example: numeric sp_num: description: Sponsorship number type: integer offset: description: Header row offset type: integer updateExisting: description: Update existing records instead of creating new ones type: boolean allowTypeTransitions: description: >- Allow reviewed donor rows to change between Individual and Organization type: boolean uniqueIdentifierColumn: description: CSV column position for unique identifier type: string uniqueIdentifierField: description: Database field name to query by for finding existing records type: string program_id: description: Program ID type: integer type: object responses: '200': description: Batch import started successfully content: application/json: schema: properties: message: type: string example: Donor/Recipient import batch has been started. batch_id: type: integer example: 123 type: object '422': description: Validation error '500': description: Server error security: - bearerAuth: [] - apiKeyAuth: [] components: 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.