Sign in

v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Settings

Update Welcome Message

Update the automatic welcome message template that is sent when someone subscribes.

post/api/{account}/settings/welcome-message

Request body

textstring

The welcome message text content. Required unless a media file is present.

lockedTextboolean

Whether the text should be shown or hidden.

priceinteger

Price for paid content (0 or between 3-200). In case this is not zero, mediaFiles is required.

rfTagstring

Array of OnlyFans Creator User IDs to tag in your message.

rfGueststring

Array of OnlyFans Release Form Guest IDs to tag in your message.

rfPartnerstring

Array of OnlyFans Release Form Partners IDs to tag in your message.

isForwardboolean

Example request

{
  "text": "<p>Hey, welcome to my profile</p>",
  "mediaFiles": [
    "ofapi_media_abc123",
    1234567890
  ],
  "previews": [
    "ofapi_media_abc123",
    1234567890
  ],
  "isForward": true
}

Response

Success

Example response

{
  "data": {
    "id": "12345678901",
    "template": "reply_on_subscribe",
    "text": "<p>Hey, welcome to my profile</p>",
    "displayText": "<p>Hey, welcome to my profile</p>",
    "price": 0,
    "lockedText": false,
    "previews": [],
    "isMediaReady": true,
    "mediaCount": 1,
    "media": [
      {
        "id": 1234567890,
        "type": "photo",
        "convertedToVideo": false,
        "canView": true,
        "hasError": false,
        "createdAt": "2026-04-28T20:44:55+00:00",
        "isReady": true,
        "files": {
          "full": {
            "url": "https://cdn2.onlyfans.com/files/example/full.jpg",
            "width": 549,
            "height": 309,
            "size": 0,
            "sources": []
          },
          "thumb": {
            "url": "https://cdn2.onlyfans.com/files/example/thumb.jpg",
            "width": 300,
            "height": 300,
            "size": 0
          },
          "preview": {
            "url": "https://cdn2.onlyfans.com/files/example/preview.jpg",
            "width": 549,
            "height": 309,
            "size": 0
          },
          "squarePreview": {
            "url": "https://cdn2.onlyfans.com/files/example/square.jpg",
            "width": 960,
            "height": 960,
            "size": 0
          }
        },
        "duration": 0,
        "releaseForms": [],
        "hasCustomPreview": false,
        "videoSources": {
          "240": null,
          "720": null
        }
      }
    ],
    "createdAt": "2026-04-28T20:44:55+00:00",
    "isActive": false,
    "giphyId": null,
    "isCouplePeopleMedia": false,
    "isMarkdownDisabled": true,
    "releaseForms": []
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999968,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 10000000,
      "limit_day": 50000,
      "remaining_minute": 9999997,
      "remaining_day": 49969
    }
  }
}