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

# Update a creator's notes about a fan

> Replaces the specified creator's notes about a fan on their behalf and returns the stored result.

These are the notes the creator keeps on a fan in the Fanvue chat sidebar and contact list. Only the manually written notes are exposed; automatically generated fan summaries are never returned. Notes do not require an existing conversation with the fan.

The body replaces the notes in full, so send the complete text rather than a delta. Pass `null` (or an empty string) to clear them. Returns 400 if `userUuid` is the creator's own UUID and 404 if the user does not exist.

> [!NOTE]
>
> **Required scopes**
>
> * `write:chat` — Create new chats and send messages. This scope is required for any chat-related actions that modify data.
> * `read:creator` — Access creator profiles, content, and creator-specific information.


## OpenAPI

````yaml /openapi-v1.json put /v1/creators/{creatorUserUuid}/chats/{userUuid}/notes
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers:
  - url: https://api.fanvue.com
security: []
paths:
  /v1/creators/{creatorUserUuid}/chats/{userUuid}/notes:
    put:
      summary: Update a creator's notes about a fan
      description: >-
        Replaces the specified creator's notes about a fan on their behalf and
        returns the stored result.


        These are the notes the creator keeps on a fan in the Fanvue chat
        sidebar and contact list. Only the manually written notes are exposed;
        automatically generated fan summaries are never returned. Notes do not
        require an existing conversation with the fan.


        The body replaces the notes in full, so send the complete text rather
        than a delta. Pass `null` (or an empty string) to clear them. Returns
        400 if `userUuid` is the creator's own UUID and 404 if the user does not
        exist.
      operationId: updateCreatorFanNotes
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
          required: true
          name: creatorUserUuid
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: userUuid
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notes:
                  type:
                    - string
                    - 'null'
                  maxLength: 5000
                  description: >-
                    The full replacement notes (max 5000 characters). Pass null
                    or an empty string to clear them.
              required:
                - notes
      responses:
        '200':
          description: The stored notes
          content:
            application/json:
              schema:
                type: object
                properties:
                  notes:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The notes kept about this fan, or null when none have been
                      written. Only the manually written notes are returned;
                      automatically generated summaries are never included.
                  updatedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: >-
                      When the notes were last changed, or null when no notes
                      are stored. The timestamp belongs to the fan's
                      customisation record, so other changes to that record,
                      including a nickname edit or internal updates, also move
                      it.
                required:
                  - notes
                  - updatedAt
              example:
                notes: Prefers evening messages. Birthday on 12 March.
                updatedAt: '2024-01-15T00:00:00.000Z'
        '400':
          description: >-
            Bad Request - API version not supported OR validation failed OR
            invalid UUID
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/InvalidUuidError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - write:chat
            - read:creator
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
    InvalidUuidError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      description: Invalid UUID format provided
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    NotFoundResponse:
      description: Not Found Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        OAuth 2.0 access token, presented as a JWT bearer token in the
        `Authorization` header. Obtain a token via the authorization-code flow;
        the scopes granted to the token determine which operations it may call.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.