ReferenceChat Messages

Send a mass message

Send a message to multiple users based on selected lists. If `scheduledAt` (or alias `scheduled_at`) is provided, the message is queued for scheduled delivery instead of being sent immediately. <Info>Scope required: `write:chat` `read:fan'</Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Fanvue-API-VersionstringRequiredDefaults to 2025-06-26
API version to use for the request

Request

This endpoint expects an object.
includedListsobjectRequired
textstringOptional1-5000 characters
mediaUuidslist of stringsOptional
pricedouble or nullOptional>=300
excludedListsobjectOptional
scheduledAtstringOptionalformat: "date-time"

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

Response

Mass message sent successfully
idstringformat: "uuid"
recipientCountdouble
createdAtstring or nullformat: "date"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
410
Gone Error
429
Too Many Requests Error