> ## 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. # Update donor profile fields inline > Updates one through eight allowlisted canonical/compatibility fields on an organization donor, including archived donors while retaining archive status. Resolved donor type rejects incompatible personal/organization identity. Legacy donor forms require full edit for address fields. Enforces email/username uniqueness, country/subdivision and preferred-contact rules; normalizes tags, geo labels and phone. Saves immediately, synchronizes configured primary-contact fields to related donors, records activity/notification and refreshes search. Does not accept profile_revision optimistic concurrency; response includes directly applied canonical fields rather than every derived/synchronized change. Requires permission: one of donors_manage. ## OpenAPI ````yaml patch /donor/{id}/field 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: /donor/{id}/field: patch: tags: - Donors summary: Update donor profile fields inline description: >- Updates one through eight allowlisted canonical/compatibility fields on an organization donor, including archived donors while retaining archive status. Resolved donor type rejects incompatible personal/organization identity. Legacy donor forms require full edit for address fields. Enforces email/username uniqueness, country/subdivision and preferred-contact rules; normalizes tags, geo labels and phone. Saves immediately, synchronizes configured primary-contact fields to related donors, records activity/notification and refreshes search. Does not accept profile_revision optimistic concurrency; response includes directly applied canonical fields rather than every derived/synchronized change. Requires permission: one of donors_manage. operationId: adminDonorPatchDonorField parameters: - name: id in: path description: Id in the current organization. required: true schema: type: integer example: 42 requestBody: description: Validated request fields for this operation. required: true content: application/json: schema: required: - fields properties: fields: $ref: '#/components/schemas/AdminDonorInlineFields' type: object responses: '200': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: properties: message: type: string example: Donor field saved fields: $ref: '#/components/schemas/AdminDonorInlineFieldsResult' type: object 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. '404': description: The donor or its organization donor form is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: Allowlist/type/address/uniqueness/geo/contact rules fail. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: AdminDonorInlineFields: description: >- One through eight named fields. Existing donor type gates personal versus organization identity. Inline address editing requires a standardized donor form. maxProperties: 8 minProperties: 1 properties: username: description: >- Nullable organization-unique username, minimum two characters. name is a compatibility alias; username wins validation when both are supplied. type: string minLength: 2 example: Example nullable: true email: description: >- Nullable organization-unique email address; can also update username when it is empty or matches the previous address. type: string format: email example: jane@example.org nullable: true first_name: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Jane nullable: true last_name: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true name: description: Compatibility username alias; stored as username. type: string minLength: 2 example: Example nullable: true phone: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true phone_e164: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true address: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true address_line1: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true street: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true address_line2: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true location: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true city: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true state: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true zip: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true country: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true country_code: description: >- Recognized ISO country code; also refreshes country name and may re-normalize the existing phone. type: string maxLength: 2 minLength: 2 example: US nullable: true subdivision_code: description: >- Subdivision valid for supplied or stored country; refreshes state name. type: string maxLength: 10 example: US-CA nullable: true postal_code: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true organization_name: description: Replacement scalar; strings are trimmed and blank becomes null. type: string example: Example nullable: true tags: description: >- Replacement tag list or legacy comma-separated string. Array tag names may not contain commas; names are sanitized, case-deduplicated and synchronized to the donor tag catalog/pivot. oneOf: - type: string example: Education,Monthly nullable: true - type: array items: oneOf: - type: string example: Education - description: First available name/value/label is used. properties: name: type: string example: Education value: type: string example: Education label: type: string example: Education type: object do_not_email: description: >- True for true, integer1 or case-insensitive1/true/on/yes; otherwise false. oneOf: - type: boolean example: true - type: integer example: 1 - type: string example: 'yes' - type: string enum: - null nullable: true do_not_mail: description: >- True for true, integer1 or case-insensitive1/true/on/yes; otherwise false. oneOf: - type: boolean example: true - type: integer example: 1 - type: string example: 'yes' - type: string enum: - null nullable: true can_receive_sms: description: >- True for true, integer1 or case-insensitive1/true/on/yes; otherwise false. oneOf: - type: boolean example: true - type: integer example: 1 - type: string example: 'yes' - type: string enum: - null nullable: true preferred_contact_method: description: Preferred contact method; null or blank clears it. type: string enum: - email - phone - sms - mail - null example: email nullable: true type: object additionalProperties: false AdminDonorInlineFieldsResult: description: >- Only directly applied canonical fields are returned; aliases map to username/street/zip. Derived country/state/phone or related-primary-contact changes may also be persisted without appearing here. properties: username: type: string example: Example nullable: true email: type: string example: Example nullable: true first_name: type: string example: Example nullable: true last_name: type: string example: Example nullable: true phone: type: string example: Example nullable: true phone_e164: type: string example: Example nullable: true street: type: string example: Example nullable: true address_line2: type: string example: Example nullable: true city: type: string example: Example nullable: true state: type: string example: Example nullable: true zip: type: string example: Example nullable: true country: type: string example: Example nullable: true country_code: type: string example: Example nullable: true subdivision_code: type: string example: Example nullable: true organization_name: type: string example: Example nullable: true tags: type: array items: type: string example: Education do_not_email: type: integer enum: - 0 - 1 example: 0 do_not_mail: type: boolean example: true can_receive_sms: type: boolean example: true preferred_contact_method: type: string enum: - email - phone - sms - mail - null example: email nullable: true 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 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 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.