Skip to main content
POST
/
api
/
{account}
/
mass-messaging
Send Mass Message
curl --request POST \
  --url https://app.onlyfansapi.com/api/{account}/mass-messaging \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userLists": [
    "fans",
    "recent",
    "following",
    "rebill_off",
    "tagged",
    1234567890
  ],
  "userIds": [
    1234567890
  ],
  "text": "Hello!",
  "lockedText": true,
  "price": 100,
  "mediaFiles": [
    "ofapi_media_abc123",
    1234567890
  ],
  "previews": [
    "ofapi_media_abc123",
    1234567890
  ],
  "scheduledDate": "2025-01-01T00:00:00.000Z",
  "saveForLater": true
}'
{
  "data": {
    "id": 123,
    "date": "2025-01-01T01:01:01+00:00",
    "isReady": true,
    "isDone": false,
    "total": -1,
    "pending": 0,
    "canUnsend": true,
    "unsendSeconds": 1000000,
    "hasError": false,
    "isCanceled": false,
    "isCouplePeopleMedia": false
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 967,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 1000,
      "limit_day": 50000,
      "remaining_minute": 998,
      "remaining_day": 49992
    }
  }
}

Authorizations

​
Authorization
string
header
required

You can retrieve your token by visiting the OnlyFansAPI Console and clicking API Keys -> Create API Key.

Path Parameters

​
account
string
required

The Account ID

Body

application/json
​
text
string
required

The message text content

Example:

"Hello!"

​
userLists
string[]

Array of user list IDs that the mass message will be sent to.

Example:
[
  "fans",
  "recent",
  "following",
  "rebill_off",
  "tagged",
  1234567890
]
​
userIds
string[]

Array of user IDs that the mass message will be sent to.

Example:
[1234567890]
​
lockedText
boolean

Whether the text should be shown or hidden

Example:

true

​
price
integer

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

Example:

100

​
mediaFiles
string[]

Array of media file upload prefixed_ids, or OF media IDs (required if price is not 0). Will be hidden if price is provided.

Example:
["ofapi_media_abc123", 1234567890]
​
previews
string[]

Array of media file upload prefixed_ids, or OF media IDs (required if price is not 0). Will be shown if price is provided. All previews values must also exist in the mediaFiles array.

Example:
["ofapi_media_abc123", 1234567890]
​
scheduledDate
string

Schedule the chat message in the future (UTC timezone).

Example:

"2025-01-01T00:00:00.000Z"

​
saveForLater
boolean

Add your message to the "Saved for later" queue.

Example:

true

Response

200 - application/json
​
data
object
​
_meta
object