> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a note > Updates the editable fields on a note. The canonical handler enforces author identity OR the `notes:edit_others` scope when called from a Cognito session; API-key callers with `notes:write` may edit any note scoped to the calling entity. Requires the `notes:write` scope. ## OpenAPI ````yaml /openapi.yaml patch /notes/{id} openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /notes/{id}: parameters: - name: id in: path required: true schema: type: string format: uuid patch: tags: - Notes summary: Update a note description: | Updates the editable fields on a note. The canonical handler enforces author identity OR the `notes:edit_others` scope when called from a Cognito session; API-key callers with `notes:write` may edit any note scoped to the calling entity. Requires the `notes:write` scope. operationId: updateNoteV1 parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: content: type: string content_html: type: string nullable: true is_pinned: type: boolean is_internal: type: boolean visible_to_account_id: type: string format: uuid nullable: true metadata: type: object responses: '200': description: Updated note content: application/json: schema: $ref: '#/components/schemas/Note' '404': $ref: '#/components/responses/Error' security: - ApiKeyAuth: - notes:write components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: | Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. schema: type: string maxLength: 255 schemas: Note: type: object description: > A polymorphic note attached to any parent resource (order, account, product, vendor, etc.) via `parent_type` + `parent_id`. Notes carry operator-authored prose plus an optional rich-text rendering (`content_html`). Pinned notes sort to the top of their parent's timeline. Soft-delete sets `deleted_at`; restore clears it. Scope: notes:read / notes:write / notes:delete. Rule 23 SSOT: `is_pinned` is written only by canonical pinNote / unpinNote; `deleted_at` only by softDeleteNote / restoreNote. properties: id: type: string format: uuid readOnly: true object: type: string example: note entity_id: type: string format: uuid readOnly: true parent_type: type: string description: >- Parent resource family (order, account, product, vendor, etc.). 1..30 chars. parent_id: type: string format: uuid content: type: string description: Plain-text note body. Operator-authored. content_html: type: string nullable: true description: Optional rich-text rendering of content for the UI. author_user_id: type: string format: uuid nullable: true description: Cognito user id of the author. Null for API-key authored notes. is_pinned: type: boolean default: false description: Pinned notes sort first within a parent. is_internal: type: boolean default: true description: If false, the note is visible on the customer portal. visible_to_account_id: type: string format: uuid nullable: true description: Optional Layer-2 narrowing for portal-visible notes. external_source: type: string nullable: true description: Migration provenance (versa, bubble). external_id: type: string nullable: true metadata: type: object description: Free-form caller metadata. Default {}. deleted_at: type: string format: date-time nullable: true readOnly: true description: Set by softDelete; cleared by restore. created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````