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

# Set Fan's Custom Name (/api-reference/fans/set-fans-custom-name)

Change the Fan's Custom Name shown in OnlyFans

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml put /api/{account}/fans/{fan_id}/custom-name
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links and tracking links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/fans/{fan_id}/custom-name:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: fan_id
        description: Fan's OnlyFans ID
        example: 11223344
        required: true
        schema:
          type: string
    put:
      summary: Set Fan's Custom Name
      operationId: setFansCustomName
      description: Change the Fan's Custom Name shown in OnlyFans
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: https://public.onlyfans.com/files/q/...
                    avatarThumbs:
                      c50: https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...
                      c144: https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...
                    header: https://public.onlyfans.com/files/2/2j/2jy/...
                    headerSize:
                      width: 792
                      height: 396
                    headerThumbs:
                      w480: https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...
                      w760: https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...
                    id: 11223344
                    name: John Doe
                    username: john-doe
                    canLookStory: false
                    canCommentStory: false
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: false
                    tipsTextEnabled: false
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 0
                    displayName: 🐳Whale ($100+)
                    notice: ""
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: null
                    subscribedByExpire: null
                    subscribedByExpireDate: 2022-02-10T19:43:21+00:00
                    subscribedByAutoprolong: null
                    subscribedIsExpiredNow: true
                    currentSubscribePrice: null
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: 12 days
                    listsStates:
                      - id: recent
                        type: recent
                        name: Recent (last 24 hours)
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: following
                        type: following
                        name: Following
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      - id: 859770744
                        type: bookmarks
                        name: Bookmarks
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: rebill_off
                        type: rebill_off
                        name: Renew Off
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: rebill_on
                        type: rebill_on
                        name: Renew On
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      - id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      - id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                    canReport: true
                    canReceiveChatMessage: false
                    hideChat: false
                    lastSeen: 2025-10-12T23:57:50+00:00
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2021-11-12T19:43:21+00:00
                      expiredAt: 2022-02-10T19:43:21+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 2 months
                      showPostsInFeed: true
                      newPostsAfterExpireCount: 266
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 4.99
                      subscribePrice: 4.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: 2025-07-30T15:06:53+00:00
                      expiredAt: 2025-08-11T18:04:17+00:00
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: No reason given
                      duration: 12 days
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 224616
                      note: Always
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: https://public.onlyfans.com/files/q/...
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...
                          c144:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...
                      header:
                        type: string
                        example: https://public.onlyfans.com/files/2/2j/2jy/...
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 792
                          height:
                            type: integer
                            example: 396
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...
                          w760:
                            type: string
                            example: https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...
                      id:
                        type: integer
                        example: 11223344
                      name:
                        type: string
                        example: John Doe
                      username:
                        type: string
                        example: john-doe
                      canLookStory:
                        type: boolean
                        example: false
                      canCommentStory:
                        type: boolean
                        example: false
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: false
                      tipsTextEnabled:
                        type: boolean
                        example: false
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: integer
                        example: 0
                      displayName:
                        type: string
                        example: 🐳Whale ($100+)
                      notice:
                        type: string
                        example: ""
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: string
                        example: null
                        nullable: true
                      subscribedByExpire:
                        type: string
                        example: null
                        nullable: true
                      subscribedByExpireDate:
                        type: string
                        example: 2022-02-10T19:43:21+00:00
                      subscribedByAutoprolong:
                        type: string
                        example: null
                        nullable: true
                      subscribedIsExpiredNow:
                        type: boolean
                        example: true
                      currentSubscribePrice:
                        type: string
                        example: null
                        nullable: true
                      subscribedOn:
                        type: string
                        example: null
                        nullable: true
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: 12 days
                      listsStates:
                        type: array
                        example:
                          - id: recent
                            type: recent
                            name: Recent (last 24 hours)
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          - id: 859770744
                            type: bookmarks
                            name: Bookmarks
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: rebill_off
                            type: rebill_off
                            name: Renew Off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: rebill_on
                            type: rebill_on
                            name: Renew On
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          - id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          - id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: recent
                            type:
                              type: string
                              example: recent
                            name:
                              type: string
                              example: Recent (last 24 hours)
                            hasUser:
                              type: boolean
                              example: false
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: SYSTEM_LIST
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: 2025-10-12T23:57:50+00:00
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2021-11-12T19:43:21+00:00
                          expiredAt:
                            type: string
                            example: 2022-02-10T19:43:21+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 2 months
                          showPostsInFeed:
                            type: boolean
                            example: true
                          newPostsAfterExpireCount:
                            type: integer
                            example: 266
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 4.99
                          subscribePrice:
                            type: number
                            example: 4.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: 2025-07-30T15:06:53+00:00
                          expiredAt:
                            type: string
                            example: 2025-08-11T18:04:17+00:00
                          renewedAt:
                            type: string
                            example: null
                            nullable: true
                          discountFinishedAt:
                            type: string
                            example: null
                            nullable: true
                          discountStartedAt:
                            type: string
                            example: null
                            nullable: true
                          status:
                            type: string
                            example: null
                            nullable: true
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: No reason given
                          duration:
                            type: string
                            example: 12 days
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224616
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Fans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: New Custom Name for a Fan. Send empty string (`""`) or `null` to
                    clear out the custom name.
                  example: 🐳Whale ($100+)
              required:
                - custom_name
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````