> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ocean.security/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit a VIP employee's comment

> Replaces the note stored against a manually added VIP. An auto-detected employee has no stored row to annotate and returns 404 — add them explicitly first. The response carries the stored row only; the directory fields the list returns are enrichment and are not part of a write response. Audit-logged.



## OpenAPI

````yaml patch /api/v1/settings/vip_employees
openapi: 3.0.0
info:
  contact: {}
  title: Ocean Security API
  version: 1.0.0
  description: Ocean Security API for threat detection and security metrics
servers:
  - url: https://api.ocean.security
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Threats
    description: Operations for retrieving threat information
  - name: Metrics
    description: Security metrics and analytics endpoints
paths:
  /api/v1/settings/vip_employees:
    patch:
      tags:
        - VIP Employees
      summary: Edit a VIP employee's comment
      description: >-
        Replaces the note stored against a manually added VIP. An auto-detected
        employee has no stored row to annotate and returns 404 — add them
        explicitly first. The response carries the stored row only; the
        directory fields the list returns are enrichment and are not part of a
        write response. Audit-logged.
      parameters:
        - description: Authentication API Key
          in: header
          name: X-Api-Key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/controllers_settings_vip.EditVipCommentRequest
        description: Mailbox and new comment
        required: true
      responses:
        '200':
          description: >-
            The updated row. Directory fields (full name, job title, department)
            are not part of a write response — read the list for those.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ocean_api_common.BaseResponse-controllers_settings_vip_VipOverride
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '404':
          description: No manually added VIP with that mailbox
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
components:
  schemas:
    controllers_settings_vip.EditVipCommentRequest:
      properties:
        comment:
          maxLength: 500
          type: string
        email:
          type: string
      required:
        - email
      type: object
    ocean_api_common.BaseResponse-controllers_settings_vip_VipOverride:
      properties:
        results:
          $ref: '#/components/schemas/controllers_settings_vip.VipOverride'
        status:
          type: integer
      type: object
    types.ErrorResponse:
      properties:
        error:
          type: string
      type: object
    controllers_settings_vip.VipOverride:
      properties:
        added_by:
          type: string
        comment:
          type: string
        date_added:
          type: string
        email:
          type: string
        source:
          type: string
        updated_at:
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key for authentication

````