Sign in
latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Enable or update a creator's automated message

Creates or replaces the automated message sent on behalf of the specified creator when the trigger fires. The message must have text or media; a non-zero price requires media.

put/creators/{creatorUserUuid}/chats/automated-messages/{trigger}

Path parameters

creatorUserUuidstring uuid required
trigger'new_subscriber' | 'new_follower' | 'subscription_canceled' | 're_subscribed' | 'renewed' | 'new_purchase' | 'first_message_reply' required

Event that sends the automated message: new_subscriber, new_follower, subscription_canceled (subscriber cancels auto-renew), re_subscribed, renewed (subscription renews), new_purchase, or first_message_reply (fan messages the creator for the first time)

Event that sends the automated message: new_subscriber, new_follower, subscription_canceled (subscriber cancels auto-renew), re_subscribed, renewed (subscription renews), new_purchase, or first_message_reply (fan messages the creator for the first time)

Headers

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

API version to use for the request

Request body

textstring

Message text content

mediaUuidsstring[]

Array of media UUIDs to attach to the message

mediaPreviewUuidstring uuid

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

Response

Automated message enabled or updated

trigger'new_subscriber' | 'new_follower' | 'subscription_canceled' | 're_subscribed' | 'renewed' | 'new_purchase' | 'first_message_reply' required

Event that sends the automated message: new_subscriber, new_follower, subscription_canceled (subscriber cancels auto-renew), re_subscribed, renewed (subscription renews), new_purchase, or first_message_reply (fan messages the creator for the first time)

enabledboolean required

Whether an automated message is active for this trigger

textstring nullable required

Message text content (null when disabled or media-only)

pricenumber nullable required

Pay-to-view price in cents (null when disabled or unpriced)

mediaUuidsstring[] required

Ordered list of media UUIDs attached to the message (empty when disabled)

mediaPreviewUuidstring uuid nullable required

UUID of the free preview media, or null when none is set

updatedAtstring date-time nullable required

When the automated message was last configured (null when disabled)