FAfanvue

List mass messages

Changed on

Returns a paginated list of mass (broadcast) messages sent by the authenticated creator, including delivery and engagement statistics.

Each item includes recipient count, view count, purchase count, and total revenue generated.

Use the includeDeleted query parameter to also retrieve deleted (unsent) mass messages. Deleted messages will have a status of UNSENT.

<Warning>This endpoint is only available to creators.</Warning>

get/chats/mass-messages

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/chats/mass-messages
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:chat

Query parameters

pageinteger

Page number to retrieve (starts from 1)

sizeinteger

Number of items to return per page (1-50, default: 15)

includeDeleted'true' | 'false'

Whether to include deleted (unsent) mass messages in the results. Defaults to false.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

List of mass messages with statistics

Changes

  • 79b9aba8a759Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status