FAfanvue

Send a mass message

Changed on

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.

post/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: write:chat, read:fan

Headers

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

API version to use for the request

Idempotency-Keystring

Opaque key that makes a send safe to retry. A mass send can take longer than the request timeout, and the campaign is already committed by then, so retrying without a key can deliver the broadcast twice. Reuse the same key on a retry: the original result is replayed once the first attempt finished, and a retry while it is still running is rejected with 409 rather than starting a second send. A key reused for a different message is rejected with 409 too, so pick a new one per send. Keys are scoped to your app and the sending creator, and are remembered for 24 hours.

Request body

textstring
mediaUuidsstring[]
mediaPreviewUuidstring uuid nullable

UUID of a single media item shown for free as a preview of a pay-to-view mass message. Requires a price and attached media.

pricenumber nullable
scheduledAtstring date-time

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

Response

Mass message sent successfully

uuidstring uuid required

UUID of the created mass message

status'SENT' | 'UNSENT' | 'SENDING' | 'FAILED' | 'MODERATED' | 'SCHEDULED'

Status right after this request, present only when dispatch is async: SENDING or SCHEDULED means delivery/recipient resolution is still in progress

publishedAtstring date nullable required

When the message was sent, or null when it is scheduled for later

recipientCountnumber nullable required

Recipients resolved from the given lists at the time of this request, or null when the immediate send resolves them asynchronously. A scheduled message re-resolves its recipients at send time, so this is a preview and GET /chats/mass-messages reports 0 until it sends.

Changes

  • 79b9aba8a759Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status

  • dce5621fe589Revision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status