> ## 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.

# Migrate donor field data between custom JSON and standardized columns

> Kicks off a background migration that copies donor field values either from per-form `json_fields` into the standardized donor columns (e.g. `first_name`, `phone`, `street`) or vice versa. The `custom_to_standardized` direction routes through `DonorStandardizationService::startMigration` (returns the run record); `standardized_to_custom` dispatches `MigrateDonorFieldsJob` directly. Optional `mapping` overrides the default custom-key mapping. Requires permission: `donors_manage`.



## OpenAPI

````yaml post /admin/donors/migrate-fields
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/donors/migrate-fields:
    post:
      tags:
        - Donors
      summary: Migrate donor field data between custom JSON and standardized columns
      description: >-
        Kicks off a background migration that copies donor field values either
        from per-form `json_fields` into the standardized donor columns (e.g.
        `first_name`, `phone`, `street`) or vice versa. The
        `custom_to_standardized` direction routes through
        `DonorStandardizationService::startMigration` (returns the run record);
        `standardized_to_custom` dispatches `MigrateDonorFieldsJob` directly.
        Optional `mapping` overrides the default custom-key mapping. Requires
        permission: `donors_manage`.
      operationId: 51b328ff894c0f0c123a3d3a6d03eeb4
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - hysform_id
                - direction
              properties:
                hysform_id:
                  description: >-
                    Donor form whose data to migrate. Must belong to the
                    authenticated client and be of `type=donor`.
                  type: integer
                  example: 42
                direction:
                  description: Direction of the migration. Any other value returns 422.
                  type: string
                  enum:
                    - custom_to_standardized
                    - standardized_to_custom
                  example: custom_to_standardized
                mapping:
                  description: >-
                    Optional override of the default custom-key →
                    standardized-key map. Defaults to
                    `MigrateDonorFieldsJob::getDefaultCustomKeys()` when
                    omitted. Non-array values are ignored.
                  type: object
                  example:
                    first_name: fname
                    last_name: lname
                  additionalProperties: true
              type: object
      responses:
        '200':
          description: >-
            Migration started. `data.run` is only present in the
            `custom_to_standardized` branch.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: >-
                      Migration started. Donor data will be updated in the
                      background.
                  status:
                    type: string
                    example: success
                  data:
                    properties:
                      run:
                        description: Migration-run record (custom_to_standardized only).
                        type: object
                    type: object
                    nullable: true
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '404':
          description: Donor form not found within the caller's client.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Donor form not found or access denied.
                  status:
                    type: string
                    example: error
                type: object
        '422':
          description: Invalid `direction` value.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: >-
                      Invalid direction. Use custom_to_standardized or
                      standardized_to_custom.
                  status:
                    type: string
                    example: error
                type: object
      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
  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.