> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. **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. ## OpenAPI ````yaml /openapi.json post /chats/mass-messages openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /chats/mass-messages: post: summary: Send a mass message description: >- 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. operationId: sendMassMessage parameters: - $ref: '#/components/parameters/ApiVersionHeader' requestBody: required: true content: application/json: schema: type: object properties: text: type: string minLength: 1 maxLength: 5000 mediaUuids: type: array items: type: string format: uuid price: type: - number - 'null' minimum: 300 includedLists: type: object properties: smartListIds: type: array items: type: string enum: - subscribers - auto_renewing - non_renewing - followers - free_trial_subscribers - expired_subscribers - spent_more_than_50 - muted - creators description: >- Smart list identifiers — fixed string types such as 'subscribers' or 'followers', not UUIDs. The deprecated alias `smartListUuids` is also accepted. customListUuids: type: array items: type: string format: uuid excludedLists: type: object properties: smartListIds: type: array items: type: string enum: - subscribers - auto_renewing - non_renewing - followers - free_trial_subscribers - expired_subscribers - spent_more_than_50 - muted - creators description: >- Smart list identifiers — fixed string types such as 'subscribers' or 'followers', not UUIDs. The deprecated alias `smartListUuids` is also accepted. customListUuids: type: array items: type: string format: uuid scheduledAt: type: string format: date-time description: >- Optional scheduled date/time in ISO 8601 format. Alias `scheduled_at` is also accepted. required: - includedLists responses: '201': description: Mass message sent successfully content: application/json: schema: type: object properties: id: type: string format: uuid recipientCount: type: number createdAt: type: - string - 'null' format: date required: - id - recipientCount - createdAt example: id: f1e2d3c4-b5a6-9788-c0d1-e2f3g4h5i6j7 recipientCount: 1250 createdAt: '2024-01-15T00:00:00.000Z' '400': description: >- Bad Request - API version not supported OR user contactability validation failed OR message validation failed content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ContactabilityError' - $ref: '#/components/schemas/MessageValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - write:chat - read:fan components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ContactabilityError: type: object properties: message: type: string required: - message description: User contactability validation failed MessageValidationError: type: object properties: message: type: string required: - message description: Message validation failed (media ownership, content validation, etc.) responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- 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. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````