Skip to main content
PUT
Update mass message broadcast

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Path Parameters

massMessageId
string
required
Pattern: ^\d+$

Body

application/json
isForwardedMessage
boolean
default:false

Whether the message was forwarded

text
string
default:""

Plain text with optional formatting marks. HTML is displayed as text. See Text formatting.

Maximum string length: 10000
replyToMessageId
string | null

Reply to an existing chat message

Minimum string length: 1
mediaItems
(integer | string)[]

Media references to attach. Accepts vault media IDs, upload references (mediaUploadId), or http(s) URLs. See mediaItems reference.

OnlyFans media ID

Required range: x > 0
isLockedText
boolean
default:false

Whether users must pay to read the text (default: false).

price
number | null
default:0

Price to unlock message content (0 for free)

Required range: 0 <= x <= 200
previewMediaCount
integer | null
default:0

Number of mediaItems to show as free previews, starting with the first item.

Required range: x >= 0
releaseForms
object

Release form participants

userTags
integer[]

Users to tag

OnlyFans user ID

Required range: x > 0
isMarkdown
boolean
default:true

Apply formatting marks (default: true). Set false to keep marks as literal text. HTML is displayed as text in both modes. See Text formatting.

scheduledDate

When to send the message (omit for immediate)

userIds
(integer | string)[]

Specific user IDs to send to

OnlyFans user ID

Required range: x > 0
userLists
(integer | string)[]

User list IDs to send to

OnlyFans user ID

Required range: x > 0
subscribedAfterDate

Only send to users subscribed after this date

excludeUserLists
(integer | string)[]

User list IDs to exclude

OnlyFans user ID

Required range: x > 0

Response

Successful response

canUnsend
boolean
required
date
string
required
hasError
boolean
required
id
number
required
isCanceled
boolean
required
isCouplePeopleMedia
boolean
required
isDone
boolean
required
isReady
boolean
required
pending
number
required
total
number
required
unsendSeconds
number
required