Skip to main content
PUT
Enable or update an automated message
Required scope
  • write:creator — Modify creator profiles, settings, and creator-specific data.

Authorizations

Authorization
string
header
required

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.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

trigger
enum<string>
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)

Available options:
new_subscriber,
new_follower,
subscription_canceled,
re_subscribed,
renewed,
new_purchase,
first_message_reply

Body

application/json
text
string

Message text content

Required string length: 1 - 5000
price

Pay-to-view price in cents: 0 (free) or between 300 and 250000. A non-zero price requires attached media.

Available options:
0
mediaUuids
string<uuid>[]

Array of media UUIDs to attach to the message

mediaPreviewUuid
string<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
enum<string>
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)

Available options:
new_subscriber,
new_follower,
subscription_canceled,
re_subscribed,
renewed,
new_purchase,
first_message_reply
enabled
boolean
required

Whether an automated message is active for this trigger

text
string | null
required

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

price
number | null
required

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

mediaUuids
string<uuid>[]
required

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

mediaPreviewUuid
string<uuid> | null
required

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

updatedAt
string<date-time> | null
required

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