Skip to main content
POST
/
chats
/
mass-messages
Send a mass message
curl --request POST \
  --url https://api.example.com/chats/mass-messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>' \
  --data '
{
  "includedLists": {
    "smartListUuids": [],
    "customListUuids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}
'
{
  "id": "f1e2d3c4-b5a6-9788-c0d1-e2f3g4h5i6j7",
  "recipientCount": 1250,
  "createdAt": "2024-01-15T00:00:00.000Z"
}
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