Skip to main content
POST
Send a mass message
Required scopes
  • write:chat — Create new chats and send messages. This scope is required for any chat-related actions that modify data.
  • read:fan — Access fan-related data and information within the platform.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
includedLists
object
required
text
string
Required string length: 1 - 5000
mediaUuids
string<uuid>[]
price
number | null
Required range: x >= 300
excludedLists
object
scheduledAt
string<date-time>

Optional scheduled date/time in ISO 8601 format. Alias scheduled_at is also accepted.

Response

Mass message sent successfully

id
string<uuid>
required
recipientCount
number
required
createdAt
string<date> | null
required