> ## 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. # Bulk-edit fields across many donors (async) > Queues a `bulkEditDonors` job for each targeted donor that applies the supplied field/value updates (admin name is captured for the activity log). Use `donor_ids` as an array of IDs to target a specific set, or the literal string `all` (with `hysform_id`) to operate on every donor of that form. The handler returns immediately once the jobs are dispatched; updates land asynchronously through the queue worker. Requires permission: `donors_manage`. ## OpenAPI ````yaml patch /admin/program/donors 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/program/donors: patch: tags: - Donors summary: Bulk-edit fields across many donors (async) description: >- Queues a `bulkEditDonors` job for each targeted donor that applies the supplied field/value updates (admin name is captured for the activity log). Use `donor_ids` as an array of IDs to target a specific set, or the literal string `all` (with `hysform_id`) to operate on every donor of that form. The handler returns immediately once the jobs are dispatched; updates land asynchronously through the queue worker. Requires permission: `donors_manage`. operationId: ae94cabfb194b4a2bc4a220ad71a26a3 requestBody: required: true content: application/json: schema: required: - donor_ids - values properties: donor_ids: description: >- Either an array of donor IDs or the literal string `all`. Validation rule: `required`. oneOf: - type: array items: type: integer example: - 1 - 2 - 3 - type: string enum: - all example: all values: description: >- Map of field name to new value to apply to every targeted donor. Keys may be standardized columns (e.g. `first_name`, `phone`) or custom keys defined in the donor form's `json_fields` schema. When `clear_fields` is true, `clear_field_keys` drives which fields are cleared; `values` may still carry real entries for the other, non-cleared selected fields in the same request, and a key present in both is cleared. type: object example: city: Springfield state: IL additionalProperties: true clear_fields: description: >- When true, clears every field listed in `clear_field_keys` in addition to applying any other entered values. type: boolean example: false clear_field_keys: description: Field keys to set empty when `clear_fields` is true. type: array items: type: string example: - first_name - phone - tags confirm_identity_transition: description: >- Required and must be true when `values.type` changes donor profile type. type: boolean example: true hysform_id: description: >- Required when `donor_ids` is `all` — the donor form whose donors should be selected. type: integer example: 42 client_id: description: >- Legacy client hint ignored by the controller; donor selection is scoped to the authenticated client. type: integer example: 207 type: object responses: '200': description: Bulk-edit jobs dispatched. content: application/json: schema: properties: message: type: string example: Donors are being edited type: object '400': description: >- Missing required input — `values` empty, `donor_ids` empty, or `hysform_id` missing when using `all`. content: application/json: schema: properties: message: type: string example: >- Error: hysform_id is required when using `all` for donor_ids. type: object '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '409': description: Donor type change requires explicit confirmation. '422': description: >- Validation error, including fields that do not apply to the target donor type. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: 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 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.