> ## 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 a note > Updates a note body and optionally its category, including notes on archived profiles. Requires notes_manage and profile access. Supplying expected_updated_at prevents overwriting a changed note. ## OpenAPI ````yaml put /notes/{id} 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: /notes/{id}: put: tags: - Communications summary: Update a note description: >- Updates a note body and optionally its category, including notes on archived profiles. Requires notes_manage and profile access. Supplying expected_updated_at prevents overwriting a changed note. operationId: updateNote parameters: - name: id in: path description: ID of the note within the caller's organization. required: true schema: type: integer example: 4422 requestBody: description: Updated note and optional concurrency check. required: true content: application/json: schema: required: - note properties: note: description: 'Replacement body. Validation rule: `required|min:3|string`.' type: string minLength: 3 example: Updated meeting notes categories: description: >- Replacement category name; omitted, null or blank values keep the existing category. Validation rule: `nullable|string|max:255`. type: string maxLength: 255 example: Meeting nullable: true expected_updated_at: description: >- Previous updated_at value. A mismatch returns 422. Validation rule: `sometimes|nullable|date`. type: string format: date-time example: '2026-10-20T09:00:00Z' nullable: true type: object responses: '200': description: Note updated successfully content: application/json: schema: properties: status: type: string example: success message: type: string example: Note updated successfully data: properties: id: type: integer example: 4422 record_type: type: string enum: - donor - entity example: donor record_id: type: integer example: 12345 note: type: string example: Called to thank the donor. category: properties: id: type: integer example: 7 category: type: string example: Phone call type: object nullable: true donor: properties: id: type: integer example: 12345 username: type: string example: alex nullable: true email: type: string format: email example: alex@example.com type: object nullable: true created_by: properties: id: type: integer example: 1024 name: type: string example: Alex Staff type: object nullable: true created_at: type: string format: date-time example: '2026-10-20T09:00:00Z' nullable: true updated_at: type: string format: date-time example: '2026-10-20T09:00:00Z' nullable: true type: object type: object '401': description: Missing or invalid bearer token or API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The caller lacks note permissions or access to the profile's donor form or program. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Note not found in the caller's organization. content: application/json: schema: properties: message: type: string example: No Note was found status: type: string example: error type: object '422': description: The payload or note freshness check failed validation. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v2 description: Gratona API v2 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 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 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.