Sign in
Mass Messaging

Send Mass Message

Send a mass message to lists and/or users. You may use both the userLists and userIds parameters to send the same message to both lists and individual users.

post/api/{account}/mass-messaging

Request body

userListsstring[]

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

userIdsstring[]

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

textstring required

The message text content

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

mediaFilesstring[]

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

previewsstring[]

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.

scheduledDatestring

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

saveForLaterboolean

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

Example request

{
  "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
}

Response

Example response

{
  "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
    }
  }
}

Changes