Skip to main content
POST
Send a chat message

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Path Parameters

userId
string
required
Pattern: ^\d+$

Body

application/json
isForwardedMessage
boolean | null
default:false

Whether this is a forwarded message

text
string
default:""

Text content. Supports markdown by default. See Text Formatting Guide.

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 | null
default:false

Whether text is locked behind paywall (defaults to false).

price
number | null
default:0

Price to unlock message content (0 for free)

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

How many items in mediaItems should be previews. Uses the first N items from left to right.

Required range: x >= 0
releaseForms
object

Release form participants

userTags
integer[]

Users to tag

OnlyFans user ID

Required range: x > 0
isMarkdown
boolean | null
default:true

Whether to parse text as markdown (default: true). See Text Formatting Guide.

Response

Successful response

id
number
required
text
string
createdAt
string
media
object[]
mediaCount
number
isMediaReady
boolean
price
isFree
boolean
lockedText
boolean
queueId
number
cancelSeconds
number