Fanvue API icon

Fanvue API

Interact with the Fanvue API

Actions74

Creators → Send Creator Mass Message

AI-generated

Summary

Send a mass message to a Fanvue creator.

Inputs

  • X-Fanvue-API-Version (required) — API version to use for the request. Sets the X-Fanvue-API-Version header. Default: 2025-06-26.
  • creatorUserUuid (required) — UUID of the creator to send the mass message to.
  • text — Message text body. Sent as the request body property 'text'. Default: empty string.
  • mediaUuids — Array of media UUIDs to include in the message. Sent as the request body property 'mediaUuids'. Default: [null].
  • price — Price for the message in the smallest currency unit. Sent as the request body property 'price'. Default: 0.
  • includedLists — Lists explicitly included for the message. Sent as the request body property 'includedLists'. Default: { smartListUuids: [null], customListUuids: [null] }.
  • excludedLists — Lists explicitly excluded from the message. Sent as the request body property 'excludedLists'. Default: { smartListUuids: [null], customListUuids: [null] }.
  • requestOptions — Configuration for request throttling via batching. Includes batchSize (items per batch, -1 for disabled) and batchInterval (ms between batches, 0 for disabled).
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible. Default: false.
  • proxy — HTTP proxy URL for the request. Format: http://proxyHost:port or http://username:password@proxyHost:port.
  • timeout — Time in ms to wait for the server to send response headers before aborting. Minimum: 1. Default: 10000.

Output shape

The Fanvue API response body from the creators mass message endpoint, typically containing the sent message details and status metadata.

Required inputs are X-Fanvue-API-Version and creatorUserUuid. All other parameters are optional and use declared defaults when omitted. The requestOptions collection allows batching control to throttle API calls.

Links

Discussion