> ## 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. # Edit a donor > Updates a donor in the authenticated organization, including archived donors while preserving their archived state. Send configured donor-form fields as top-level properties; required fields and conditional visibility depend on the donor form. A donor type change requires the loaded type, profile revision, and explicit confirmation. Requires permission: `donors_manage`. ## OpenAPI ````yaml patch /donor/{id}/edit 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: /donor/{id}/edit: patch: tags: - Donors summary: Edit a donor description: >- Updates a donor in the authenticated organization, including archived donors while preserving their archived state. Send configured donor-form fields as top-level properties; required fields and conditional visibility depend on the donor form. A donor type change requires the loaded type, profile revision, and explicit confirmation. Requires permission: `donors_manage`. operationId: ec33afacdfbb51eb67ebdf11bbf3c8eb parameters: - name: id in: path description: ID of the donor whose profile is being edited. required: true schema: type: integer example: 12345 requestBody: description: >- Donor profile fields. The organization and donor form are taken from the authenticated context and existing donor. Include any required standard or custom fields from the donor form contract. required: true content: application/json: schema: properties: username: description: Login username; must be unique within the organization. type: string minLength: 5 example: jane.donor email: description: >- Email address; must be unique within the organization when provided. type: string format: email example: jane@example.org nullable: true password: description: >- Optional replacement password; an empty value leaves the existing password unchanged. type: string format: password minLength: 5 example: new-donor-password type: description: >- Donor identity type. Changing an existing type requires the transition confirmation fields. type: string enum: - INDIVIDUAL - ORGANIZATION example: INDIVIDUAL first_name: description: >- Individual first name on standardized donor forms; form configuration controls whether it is required. type: string example: Jane nullable: true last_name: description: >- Individual last name on standardized donor forms; form configuration controls whether it is required. type: string example: Doe nullable: true organization_name: description: Required when the submitted donor type is ORGANIZATION. type: string maxLength: 255 example: Example Foundation phone: description: Phone number on standardized donor forms. type: string example: '+12565550123' nullable: true street: description: Street address on standardized donor forms. type: string example: 123 Main Street nullable: true address_line2: description: Additional address line on standardized donor forms. type: string example: Suite 2 nullable: true city: description: City on standardized donor forms. type: string example: Huntsville nullable: true zip: description: Postal code on standardized donor forms. type: string example: '35801' nullable: true country_code: description: Valid two-letter country code on standardized donor forms. type: string maxLength: 2 minLength: 2 example: US nullable: true subdivision_code: description: >- Subdivision code belonging to the submitted country on standardized donor forms. type: string maxLength: 10 example: US-AL nullable: true preferred_contact_method: description: >- Preferred communication channel; nullable to clear the preference. type: string enum: - email - phone - sms - mail example: email nullable: true can_receive_sms: description: Whether the donor can receive SMS messages. type: boolean example: false do_not_email: description: >- Whether the donor should be excluded from email communications. type: boolean example: false do_not_mail: description: >- Whether the donor should be excluded from postal mail communications. type: boolean example: false tags: description: >- Tag names as an array or comma-separated string. Individual tag names may not contain commas; null clears the tags. example: - Major Donor - Newsletter oneOf: - type: array items: type: string nullable: true - type: string policy_revision: description: >- Revision from the loaded standard-field contract; a mismatch returns 409. type: string example: loaded-form-policy-revision expected_type: description: >- Previously loaded donor type, required when changing an existing type. type: string enum: - INDIVIDUAL - ORGANIZATION example: INDIVIDUAL expected_profile_revision: description: >- Previously loaded profile revision. Required for a type transition; when supplied, also protects other edits from concurrent changes. type: integer example: 4 confirm_identity_transition: description: >- Explicit confirmation required when changing an existing donor type. type: boolean example: true type: object responses: '200': description: Donor profile saved content: application/json: schema: properties: status: type: string example: success data: properties: message: type: string example: Profile saved type: object type: object '403': description: Insufficient permission content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Donor not found in the organization content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '409': description: >- Stale donor profile or form contract, or missing confirmation for a donor type change. Form-contract conflicts also return the current standard_field_contract. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Invalid donor identity, credentials, or required form fields content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: 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 NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found 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.