Skip to main content
POST
Send a mass message as creator
Required scopes
  • write:chat — Create new chats and send messages. This scope is required for any chat-related actions that modify data.
  • read:creator — Access creator profiles, content, and creator-specific information.
  • 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"

Idempotency-Key
string

Opaque key that makes a send safe to retry. A mass send can take longer than the request timeout, and the campaign is already committed by then, so retrying without a key can deliver the broadcast twice. Reuse the same key on a retry: the original result is replayed once the first attempt finished, and a retry while it is still running is rejected with 409 rather than starting a second send. A key reused for a different message is rejected with 409 too, so pick a new one per send. Keys are scoped to your app and the sending creator, and are remembered for 24 hours.

Maximum string length: 255

Path Parameters

creatorUserUuid
string<uuid>
required

Body

application/json
includedLists
object
required
text
string
Required string length: 1 - 5000
mediaUuids
string<uuid>[]
mediaPreviewUuid
string<uuid> | null

UUID of a single media item shown for free as a preview of a pay-to-view mass message. Requires a price and attached media.

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

uuid
string<uuid>
required

UUID of the created mass message

publishedAt
string<date> | null
required

When the message was sent, or null when it is scheduled for later

recipientCount
number
required

Recipients resolved from the given lists at the time of this request. A scheduled message re-resolves its recipients at send time, so this is a preview and GET /chats/mass-messages reports 0 until it sends.