# Fanvue API Documentation ## Docs - [Add media to creator vault folder](https://api.fanvue.com/docs/api-reference/add-media-to-creator-vault-folder.md): Add one or more media items to the specified creator folder. Media items must belong to the creator. - [Add media to folder](https://api.fanvue.com/docs/api-reference/add-media-to-folder.md): Add one or more media items to the specified folder. Media items must belong to the authenticated user. - [Add members to a creator's custom list](https://api.fanvue.com/docs/api-reference/add-members-to-a-creators-custom-list.md): Add one or more users to a custom list for the specified creator. Existing members will be skipped. - [Add members to a custom list](https://api.fanvue.com/docs/api-reference/add-members-to-a-custom-list.md): Add one or more users to a custom list. Existing members will be skipped. - [Block a user on behalf of a creator](https://api.fanvue.com/docs/api-reference/block-a-user-on-behalf-of-a-creator.md): Block a user on behalf of the specified creator. - [Bulk-create posts across creators](https://api.fanvue.com/docs/api-reference/bulk-create-posts-across-creators.md): Create (and optionally schedule) multiple posts across one or more creators in a single request. - [Check if a creator has purchased a media link](https://api.fanvue.com/docs/api-reference/check-if-a-creator-has-purchased-a-media-link.md): Returns whether the specified creator has a paid invoice for the given media link. - [Check if the authenticated user has purchased a media link](https://api.fanvue.com/docs/api-reference/check-if-the-authenticated-user-has-purchased-a-media-link.md): Returns whether the authenticated user has a paid invoice for the given media link. - [Complete creator's upload session](https://api.fanvue.com/docs/api-reference/complete-creators-upload-session.md): Complete multipart upload in S3 for creator's media and set media status to processing. Media URLs will be available once processing completes. - [Complete upload session](https://api.fanvue.com/docs/api-reference/complete-upload-session.md): Complete multipart upload in S3 and set media status to processing. Media URLs will be available once processing completes. - [Create a checkout link](https://api.fanvue.com/docs/api-reference/create-a-checkout-link.md): Create a shareable checkout link selling either an existing product price (`existing_price`), a new price on an existing product (`existing_product`), or a brand-new product (`new_product`). - [Create a checkout link for a creator](https://api.fanvue.com/docs/api-reference/create-a-checkout-link-for-a-creator.md): Create a shareable checkout link on behalf of the specified creator, selling either an existing product price (`existing_price`), a new price on an existing product (`existing_product`), or a brand-new product (`new_product`). - [Create a comment on a post](https://api.fanvue.com/docs/api-reference/create-a-comment-on-a-post.md): Create a new comment on a specific post. Only the post owner can create comments via this endpoint. - [Create a comment on a post for a creator](https://api.fanvue.com/docs/api-reference/create-a-comment-on-a-post-for-a-creator.md): Create a new comment on a specific post on behalf of a creator. - [Create a content collection](https://api.fanvue.com/docs/api-reference/create-a-content-collection.md): Create a new content collection for the authenticated creator. - [Create a creator vault folder](https://api.fanvue.com/docs/api-reference/create-a-creator-vault-folder.md): Create a new folder in the specified creator's vault. - [Create a custom list](https://api.fanvue.com/docs/api-reference/create-a-custom-list.md): Create a new custom list for organizing contacts. - [Create a custom list for a creator](https://api.fanvue.com/docs/api-reference/create-a-custom-list-for-a-creator.md): Create a new custom list for organizing the specified creator's contacts. - [Create a free trial link](https://api.fanvue.com/docs/api-reference/create-a-free-trial-link.md): Create a shareable link that lets fans start a free trial of the creator's subscription. - [Create a free trial link for a creator](https://api.fanvue.com/docs/api-reference/create-a-free-trial-link-for-a-creator.md): Create a shareable link on behalf of the specified creator that lets fans start a free trial of their subscription. - [Create a media link](https://api.fanvue.com/docs/api-reference/create-a-media-link.md): Create a shareable media link that bundles one or more vault media items for a single unlock price. All referenced media must be owned by the creator. Amounts are integer minor units of the currency (e.g. cents: 1999 = $19.99). Requires media links to be enabled. - [Create a new chat](https://api.fanvue.com/docs/api-reference/create-a-new-chat.md): Create a new chat conversation with a user. - [Create a new post](https://api.fanvue.com/docs/api-reference/create-a-new-post.md): Create a new post with optional media, text, and pricing. - [Create a new post for a creator](https://api.fanvue.com/docs/api-reference/create-a-new-post-for-a-creator.md): Create a new post on behalf of a creator with optional media, text, and pricing. - [Create a promotion](https://api.fanvue.com/docs/api-reference/create-a-promotion.md): Create a promotional subscription offer: either a first-month discount (`discountPercent`) or a free trial, never both. For a free trial, set `freeTrialDays` (1-30), or set `freeTrial: true` without `freeTrialDays` for an unlimited (free-forever) trial. - [Create a promotion for a creator](https://api.fanvue.com/docs/api-reference/create-a-promotion-for-a-creator.md): Create a promotional subscription offer on behalf of the specified creator: either a first-month discount (`discountPercent`) or a free trial, never both. For a free trial, set `freeTrialDays` (1-30), or set `freeTrial: true` without `freeTrialDays` for an unlimited (free-forever) trial. - [Create a template message](https://api.fanvue.com/docs/api-reference/create-a-template-message.md): Creates a template message in one of the creator's folders. Provide a `folderUuid` from GET /chats/templates/folders. A template must have text or at least one media attachment. - [Create a tracking link](https://api.fanvue.com/docs/api-reference/create-a-tracking-link.md): Create a new tracking link for the authenticated user. - [Create a tracking link for a creator](https://api.fanvue.com/docs/api-reference/create-a-tracking-link-for-a-creator.md): Create a new tracking link for the specified creator. - [Create a vault folder](https://api.fanvue.com/docs/api-reference/create-a-vault-folder.md): Create a new folder in the authenticated user's vault. - [Create a webhook subscription](https://api.fanvue.com/docs/api-reference/create-a-webhook-subscription.md): Subscribe a public HTTPS URL to one or more platform events. Every requested event is delivered to the same URL and signed with the single `signingSecret` returned in the response — store it, as it is only returned at creation time. The token must hold the OAuth scope each requested event needs: `re… - [Create multipart upload session](https://api.fanvue.com/docs/api-reference/create-multipart-upload-session.md): Create a media record and start an S3 multipart upload session. - [Create multipart upload session for creator](https://api.fanvue.com/docs/api-reference/create-multipart-upload-session-for-creator.md): Create a media record for a creator and start an S3 multipart upload session. - [Create new chat as creator](https://api.fanvue.com/docs/api-reference/create-new-chat-as-creator.md): Create a new chat conversation as a creator. - [Delete a checkout link](https://api.fanvue.com/docs/api-reference/delete-a-checkout-link.md): Soft-delete a checkout link so it can no longer be purchased or re-enabled. Deletion is terminal; past payments remain available on the payments endpoints. - [Delete a comment from a post](https://api.fanvue.com/docs/api-reference/delete-a-comment-from-a-post.md): Delete a comment from a post. The comment can be deleted by either the comment author or the post owner. - [Delete a comment from a post for a creator](https://api.fanvue.com/docs/api-reference/delete-a-comment-from-a-post-for-a-creator.md): Delete a comment from a post on behalf of a creator. The comment can be deleted if the creator is either the comment author or the post owner. - [Delete a content collection](https://api.fanvue.com/docs/api-reference/delete-a-content-collection.md): Delete a content collection owned by the authenticated creator. Posts assigned to the collection remain; only the collection association is removed. - [Delete a creator mass message](https://api.fanvue.com/docs/api-reference/delete-a-creator-mass-message.md): Delete/unsend a previously sent mass message for the specified creator. - [Delete a creator's checkout link](https://api.fanvue.com/docs/api-reference/delete-a-creators-checkout-link.md): Soft-delete the specified creator's checkout link so it can no longer be purchased or re-enabled. Deletion is terminal; past payments remain available on the payments endpoints. - [Delete a creator's custom list](https://api.fanvue.com/docs/api-reference/delete-a-creators-custom-list.md): Delete a custom list for the specified creator. All members will be removed from the list. - [Delete a creator's free trial link](https://api.fanvue.com/docs/api-reference/delete-a-creators-free-trial-link.md): Delete the specified creator's free trial link so it can no longer be redeemed. Fans already on a trial keep it until it ends. - [Delete a creator's media from the vault](https://api.fanvue.com/docs/api-reference/delete-a-creators-media-from-the-vault.md): Soft-deletes a media item from the specified creator's vault, on-behalf of the creator. - [Delete a custom list](https://api.fanvue.com/docs/api-reference/delete-a-custom-list.md): Delete a custom list. All members will be removed from the list. - [Delete a free trial link](https://api.fanvue.com/docs/api-reference/delete-a-free-trial-link.md): Delete a free trial link so it can no longer be redeemed. Fans already on a trial keep it until it ends. - [Delete a mass message](https://api.fanvue.com/docs/api-reference/delete-a-mass-message.md): Delete/unsend a previously sent mass message. - [Delete a media link](https://api.fanvue.com/docs/api-reference/delete-a-media-link.md): Soft-delete a media link so it can no longer be viewed or purchased. Deletion is terminal. Past purchases keep their access. - [Delete a message](https://api.fanvue.com/docs/api-reference/delete-a-message.md): Delete/unsend a previously sent message from a chat conversation. - [Delete a message as a creator](https://api.fanvue.com/docs/api-reference/delete-a-message-as-a-creator.md): Delete/unsend a previously sent message from a creator's chat conversation. - [Delete a post](https://api.fanvue.com/docs/api-reference/delete-a-post.md): Soft-delete an existing post. Only the post owner can delete their own post. - [Delete a post for a creator](https://api.fanvue.com/docs/api-reference/delete-a-post-for-a-creator.md): Soft-delete an existing post on behalf of a creator. - [Delete a template message](https://api.fanvue.com/docs/api-reference/delete-a-template-message.md): Deletes a template message by UUID. - [Delete a tracking link](https://api.fanvue.com/docs/api-reference/delete-a-tracking-link.md): Delete a tracking link for the authenticated user. - [Delete a tracking link for a creator](https://api.fanvue.com/docs/api-reference/delete-a-tracking-link-for-a-creator.md): Delete a tracking link for the specified creator. - [Delete a webhook subscription](https://api.fanvue.com/docs/api-reference/delete-a-webhook-subscription.md): Delete a webhook subscription owned by the authenticated creator. - [Delete creator vault folder](https://api.fanvue.com/docs/api-reference/delete-creator-vault-folder.md): Delete a folder from the specified creator's vault. Media items in the folder will be detached but not deleted. - [Delete media from vault](https://api.fanvue.com/docs/api-reference/delete-media-from-vault.md): Soft-deletes a media item from the authenticated user's vault. - [Delete vault folder](https://api.fanvue.com/docs/api-reference/delete-vault-folder.md): Delete a folder from the authenticated user's vault. Media items in the folder will be detached but not deleted. - [Disable a creator's automated message](https://api.fanvue.com/docs/api-reference/disable-a-creators-automated-message.md): Disables the specified creator's automated message for the trigger. Returns 404 if the trigger is not currently enabled. - [Disable an automated message](https://api.fanvue.com/docs/api-reference/disable-an-automated-message.md): Disables the automated message for the trigger. Returns 404 if the trigger is not currently enabled. - [Edit a creator's free trial link](https://api.fanvue.com/docs/api-reference/edit-a-creators-free-trial-link.md): Edit the specified creator's free trial link settings. The link keeps its UUID (and shareable URL) and its redemption count; fans already on a trial are unaffected. Omitted fields reset to their unlimited/default state. - [Edit a creator's promotion](https://api.fanvue.com/docs/api-reference/edit-a-creators-promotion.md): Edit the specified creator's promotion by replacing it, exactly like editing from the dashboard: the referenced promotion is stopped, a new promotion is created with the provided values, and eligible fans are notified of the updated offer. - [Edit a free trial link](https://api.fanvue.com/docs/api-reference/edit-a-free-trial-link.md): Edit an existing free trial link's settings. The link keeps its UUID (and shareable URL) and its redemption count; fans already on a trial are unaffected. Omitted fields reset to their unlimited/default state. - [Edit a promotion](https://api.fanvue.com/docs/api-reference/edit-a-promotion.md): Edit a promotion by replacing it, exactly like editing from the dashboard: the referenced promotion is stopped, a new promotion is created with the provided values, and eligible fans are notified of the updated offer. - [Enable or disable a checkout link](https://api.fanvue.com/docs/api-reference/enable-or-disable-a-checkout-link.md): Toggle a checkout link's status. Disabling is reversible: the link's checkout page stops accepting purchases until it is set back to active. Deleted links cannot be re-enabled. - [Enable or disable a creator's checkout link](https://api.fanvue.com/docs/api-reference/enable-or-disable-a-creators-checkout-link.md): Toggle the specified creator's checkout link status. Disabling is reversible: the link's checkout page stops accepting purchases until it is set back to active. Deleted links cannot be re-enabled. - [Enable or update a creator's automated message](https://api.fanvue.com/docs/api-reference/enable-or-update-a-creators-automated-message.md): 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. - [Enable or update an automated message](https://api.fanvue.com/docs/api-reference/enable-or-update-an-automated-message.md): Creates or replaces the automated message sent when the trigger fires. The message must have text or media; a non-zero price requires media. - [Exchange a fan experience launch token](https://api.fanvue.com/docs/api-reference/exchange-a-fan-experience-launch-token.md): Exchanges the opaque experience token an app's fan-experience surface received in its iframe URL for the resolved experience, the fan's identity, and the fan's entitlement to the experience. - [Get a creator's account health](https://api.fanvue.com/docs/api-reference/get-a-creators-account-health.md): Get the specified creator's account health summary: total warnings issued against the account and how many media items moderation has removed or is currently reviewing. - [Get a creator's checkout-link payment by invoice number](https://api.fanvue.com/docs/api-reference/get-a-creators-checkout-link-payment-by-invoice-number.md): Fetch a single checkout-link payment by its Fanvue `invoiceNumber`, scoped to the specified creator. Returns 404 if the payment does not exist or does not belong to this creator. - [Get a creator's post by UUID](https://api.fanvue.com/docs/api-reference/get-a-creators-post-by-uuid.md): Returns a specific post owned by the specified creator by its UUID. - [Get a one-time (app-OTP) payment by invoice number for a developer-owned app](https://api.fanvue.com/docs/api-reference/get-a-one-time-app-otp-payment-by-invoice-number-for-a-developer-owned-app.md): Owner-only. Fetches a single payment (any buyer's) by Fanvue invoice number for an app the developer owns. 404 for unknown/pre-migration invoice numbers. - [Get a published app store app's full listing](https://api.fanvue.com/docs/api-reference/get-a-published-app-store-apps-full-listing.md): Returns the full listing for a single published app: description body, highlights, screenshots, pricing plans and rating distribution. - [Get a single chat](https://api.fanvue.com/docs/api-reference/get-a-single-chat.md): Returns the details of a single chat conversation between the authenticated user and the specified user, including read state, last message metadata, mute status, and unread message count. - [Get a single message](https://api.fanvue.com/docs/api-reference/get-a-single-message.md): Returns a single message from a chat conversation with the specified user, by message UUID. - [Get a single template message](https://api.fanvue.com/docs/api-reference/get-a-single-template-message.md): Returns a specific template message by UUID. - [Get account health](https://api.fanvue.com/docs/api-reference/get-account-health.md): Get the authenticated creator's account health summary: total warnings issued against the account and how many media items moderation has removed or is currently reviewing. - [Get account view for a managed creator](https://api.fanvue.com/docs/api-reference/get-account-view-for-a-managed-creator.md): Get the account view (profile, status, earnings totals, last payout, fan counts) for a creator the authenticated agency team member manages. - [Get agency creators](https://api.fanvue.com/docs/api-reference/get-agency-creators.md): Returns a paginated list of creators associated with the authenticated agency user's organization. - [Get agency insights headline metrics](https://api.fanvue.com/docs/api-reference/get-agency-insights-headline-metrics.md): Returns the headline metrics for the authenticated user's agency: total earnings, newly acquired fans, average revenue per paying fan, the 30-day retention snapshot and average fan lifetime, aggregated across every creator the agency manages. - [Get aggregated earnings summary](https://api.fanvue.com/docs/api-reference/get-aggregated-earnings-summary.md): Returns pre-aggregated earnings metrics for the authenticated creator, including all-time totals, month-over-month comparisons, source/type breakdowns, chart series, and averages. - [Get aggregated earnings summary for a creator](https://api.fanvue.com/docs/api-reference/get-aggregated-earnings-summary-for-a-creator.md): Returns pre-aggregated earnings metrics for the specified creator, including all-time totals, month-over-month comparisons, source/type breakdowns, chart series, and averages. - [Get app pricing subscription lifecycle status](https://api.fanvue.com/docs/api-reference/get-app-pricing-subscription-lifecycle-status.md): Returns pricing plan lifecycle states for a developer-owned app (`pending_setup`, `active`, `withdrawn`). - [Get bulk media by UUIDs](https://api.fanvue.com/docs/api-reference/get-bulk-media-by-uuids.md): Returns multiple media items in a single request. - [Get bulk media by UUIDs for a creator](https://api.fanvue.com/docs/api-reference/get-bulk-media-by-uuids-for-a-creator.md): Returns multiple media items owned by the specified creator in a single request. - [Get chats of a creator](https://api.fanvue.com/docs/api-reference/get-chats-of-a-creator.md): Returns a paginated list of chats for the specified creator. - [Get chatter leaderboard](https://api.fanvue.com/docs/api-reference/get-chatter-leaderboard.md): Returns per-chatter performance metrics for the authenticated user's agency over a specified time period. - [Get comments for a post](https://api.fanvue.com/docs/api-reference/get-comments-for-a-post.md): Returns a paginated list of comments on a specific post. Only the post owner can view comments. - [Get comments on a creator's post](https://api.fanvue.com/docs/api-reference/get-comments-on-a-creators-post.md): Returns a paginated list of comments on a specific post on behalf of a creator. The creator must own the post. - [Get creator followers](https://api.fanvue.com/docs/api-reference/get-creator-followers.md): Returns a paginated list of users who follow the specified creator. - [Get creator notifications feed](https://api.fanvue.com/docs/api-reference/get-creator-notifications-feed.md): Returns a paginated list of notifications received by the specified creator. Optionally filter by event type. - [Get creator subscribers](https://api.fanvue.com/docs/api-reference/get-creator-subscribers.md): Returns a paginated list of users subscribed to the specified creator. - [Get creator vault folder details](https://api.fanvue.com/docs/api-reference/get-creator-vault-folder-details.md): Returns details of a specific creator vault folder by name. - [Get creator's custom list members](https://api.fanvue.com/docs/api-reference/get-creators-custom-list-members.md): Get members of a specific custom list for a creator with pagination. - [Get creator's custom lists](https://api.fanvue.com/docs/api-reference/get-creators-custom-lists.md): Get a creator's custom lists with member counts. Supports pagination. - [Get creator's media by UUID](https://api.fanvue.com/docs/api-reference/get-creators-media-by-uuid.md): Returns a specific media item by its UUID for the specified creator. - [Get creator's media list](https://api.fanvue.com/docs/api-reference/get-creators-media-list.md): Returns a paginated list of media items for the specified creator. - [Get creator's smart list members](https://api.fanvue.com/docs/api-reference/get-creators-smart-list-members.md): Get members of a specific smart list for a creator with pagination. - [Get creator's smart lists](https://api.fanvue.com/docs/api-reference/get-creators-smart-lists.md): Get all available smart lists for a specific creator with member counts. - [Get current user](https://api.fanvue.com/docs/api-reference/get-current-user.md): Get details of the currently authenticated user. - [Get current user subscription for an installed app](https://api.fanvue.com/docs/api-reference/get-current-user-subscription-for-an-installed-app.md): Returns paid entitlement for the authenticated user for the app identified by `appUuid`. The OAuth access token must belong to that app. - [Get current user's account](https://api.fanvue.com/docs/api-reference/get-current-users-account.md): Get the authenticated user's account view: profile, status, earnings totals, last payout, and fan counts. - [Get custom list members](https://api.fanvue.com/docs/api-reference/get-custom-list-members.md): Get members of a specific custom list with pagination. - [Get custom lists](https://api.fanvue.com/docs/api-reference/get-custom-lists.md): Get user's custom lists with member counts. Supports pagination and optional name search. - [Get earnings data](https://api.fanvue.com/docs/api-reference/get-earnings-data.md): Returns cursor-paginated invoice data for the authenticated creator over a specified time period. Each transaction includes information about the fan who made the payment. Reversals are included as `refund`/`chargeback` rows with negative gross (matching /insights/spending); filter them with `source… - [Get earnings data for a creator](https://api.fanvue.com/docs/api-reference/get-earnings-data-for-a-creator.md): Returns cursor-paginated invoice data for the specified creator over a specified time period. Each transaction includes information about the fan who made the payment. Reversals are included as `refund`/`chargeback` rows with negative gross (matching /insights/spending); filter them with `source`. - [Get earnings percentile](https://api.fanvue.com/docs/api-reference/get-earnings-percentile.md): Returns the earnings percentile bucket the authenticated creator falls into based on their gross earnings over the last 30 days. - [Get earnings percentile for a creator](https://api.fanvue.com/docs/api-reference/get-earnings-percentile-for-a-creator.md): Returns the earnings percentile bucket the specified creator falls into based on their gross earnings over the last 30 days. - [Get fan insights](https://api.fanvue.com/docs/api-reference/get-fan-insights.md): Returns detailed insights about a specific fan for the authenticated creator, including spending statistics, subscription status, and fan engagement metrics. - [Get fan insights for a creator](https://api.fanvue.com/docs/api-reference/get-fan-insights-for-a-creator.md): Returns detailed insights about a specific fan for the specified creator, including spending statistics, subscription status, and fan engagement metrics. - [Get fan insights in bulk](https://api.fanvue.com/docs/api-reference/get-fan-insights-in-bulk.md): Returns detailed insights for multiple fans in a single request. - [Get fan insights in bulk for a creator](https://api.fanvue.com/docs/api-reference/get-fan-insights-in-bulk-for-a-creator.md): Returns detailed insights for multiple fans of the specified creator in a single request. - [Get fan insights in bulk for a creator (POST batch)](https://api.fanvue.com/docs/api-reference/get-fan-insights-in-bulk-for-a-creator-post-batch.md): Returns detailed insights for up to 100 fans of the specified creator in a single request, keyed by the input fan UUID. - [Get fan insights in bulk (POST batch)](https://api.fanvue.com/docs/api-reference/get-fan-insights-in-bulk-post-batch.md): Returns detailed insights for up to 100 fans in a single request, keyed by the input fan UUID. - [Get fan profiles in bulk](https://api.fanvue.com/docs/api-reference/get-fan-profiles-in-bulk.md): Returns profile data (handle, display name, avatar, nickname) for up to 100 fans in a single request, keyed by the input fan UUID. - [Get fan retention summary](https://api.fanvue.com/docs/api-reference/get-fan-retention-summary.md): Returns the authenticated creator's weekly fan-health snapshots, including paid/free active fans, churn, retention, reactivation, revenue retention, LTV, free-to-paid conversion, and engagement metrics. Snapshots are computed weekly by the data warehouse (not real-time); the most recent snapshot may… - [Get fan retention summary for a creator](https://api.fanvue.com/docs/api-reference/get-fan-retention-summary-for-a-creator.md): Returns the specified creator's weekly fan-health snapshots, including paid/free active fans, churn, retention, reactivation, revenue retention, LTV, free-to-paid conversion, and engagement metrics. Snapshots are computed weekly by the data warehouse (not real-time); the most recent snapshot may be… - [Get followers](https://api.fanvue.com/docs/api-reference/get-followers.md): Returns a paginated list of users who follow the authenticated user, excluding those with active subscriptions to avoid duplication. - [Get likes for a creator's post](https://api.fanvue.com/docs/api-reference/get-likes-for-a-creators-post.md): Returns a paginated list of likes received on a specific post owned by the specified creator. - [Get likes for a post](https://api.fanvue.com/docs/api-reference/get-likes-for-a-post.md): Returns a paginated list of likes received on a specific post. - [Get list of chats](https://api.fanvue.com/docs/api-reference/get-list-of-chats.md): Returns a paginated list of chat conversations with optional filtering, searching, and sorting. - [Get list of posts](https://api.fanvue.com/docs/api-reference/get-list-of-posts.md): Returns a paginated list of posts created by the authenticated user. Posts are ordered by pinned status first, then by publication date (newest first). - [Get list of template folders](https://api.fanvue.com/docs/api-reference/get-list-of-template-folders.md): Returns a paginated list of the creator's template folders. Use a folder UUID when creating a template with POST /chats/templates. - [Get list of template messages](https://api.fanvue.com/docs/api-reference/get-list-of-template-messages.md): Returns a paginated list of template messages. Optionally filter by folder name using case-insensitive partial matching. - [Get media by UUID](https://api.fanvue.com/docs/api-reference/get-media-by-uuid.md): Returns a specific media item by its UUID for the authenticated user. - [Get media for an entitled consumer](https://api.fanvue.com/docs/api-reference/get-media-for-an-entitled-consumer.md): Returns a media item with signed variant URLs, but only if the specified consumer has been granted access via a prior grant call. - [Get media for an entitled consumer of a creator](https://api.fanvue.com/docs/api-reference/get-media-for-an-entitled-consumer-of-a-creator.md): Returns a media item owned by the specified creator with signed variant URLs, but only if the specified consumer has been granted access via a prior grant call. - [Get media from a chat](https://api.fanvue.com/docs/api-reference/get-media-from-a-chat.md): Returns a cursor-paginated list of media items shared between the authenticated user and the specified user. Media is extracted from chat messages and ordered by date (newest first). - [Get media from a creator's chat](https://api.fanvue.com/docs/api-reference/get-media-from-a-creators-chat.md): Returns a cursor-paginated list of media items shared between the specified creator and user. Media is extracted from chat messages and ordered by date (newest first). - [Get messages between a creator and a user](https://api.fanvue.com/docs/api-reference/get-messages-between-a-creator-and-a-user.md): Returns a paginated list of text messages between the specified creator and user. Messages are ordered by creation date (newest first). - [Get messages from a chat](https://api.fanvue.com/docs/api-reference/get-messages-from-a-chat.md): Returns a paginated list of text messages between the authenticated user and the specified user. Messages are ordered by creation date (newest first). - [Get messages from multiple chats in bulk](https://api.fanvue.com/docs/api-reference/get-messages-from-multiple-chats-in-bulk.md): Returns the most recent messages for up to 50 chats in a single request, keyed by the input chat UUID (the counterpart user UUID). - [Get messages from multiple chats in bulk across the agency's creators (POST batch)](https://api.fanvue.com/docs/api-reference/get-messages-from-multiple-chats-in-bulk-across-the-agencys-creators-post-batch.md): Returns the most recent messages for chats grouped by creator, across the creators the authenticated user's agency manages, in a single request. - [Get messages from multiple chats in bulk for a creator](https://api.fanvue.com/docs/api-reference/get-messages-from-multiple-chats-in-bulk-for-a-creator.md): Returns the most recent messages for up to 50 chats in a single request for the specified creator, keyed by the input chat UUID (the counterpart user UUID). - [Get notifications feed](https://api.fanvue.com/docs/api-reference/get-notifications-feed.md): Returns a paginated list of notifications for the authenticated user, ordered by most recent first. Optionally filter by event type. - [Get online statuses for multiple users](https://api.fanvue.com/docs/api-reference/get-online-statuses-for-multiple-users.md): Returns the online status and last seen timestamp for multiple users in a single request. - [Get online statuses for multiple users as a creator](https://api.fanvue.com/docs/api-reference/get-online-statuses-for-multiple-users-as-a-creator.md): Returns the online status and last seen timestamp for multiple users in a single request, from the perspective of the specified creator. - [Get online subscribers](https://api.fanvue.com/docs/api-reference/get-online-subscribers.md): Returns subscribers who are currently online for the specified creator. - [Get post by UUID](https://api.fanvue.com/docs/api-reference/get-post-by-uuid.md): Returns a specific post owned by the authenticated user by its UUID. - [Get posts for a creator](https://api.fanvue.com/docs/api-reference/get-posts-for-a-creator.md): Returns a paginated list of posts created by the specified creator. Posts are ordered by pinned status first, then by publication date (newest first). - [Get signed URL for upload part](https://api.fanvue.com/docs/api-reference/get-signed-url-for-upload-part.md): Return a presigned URL to upload a specific part number for creator's media upload session. - [Get smart list members](https://api.fanvue.com/docs/api-reference/get-smart-list-members.md): Get members of a specific smart list with pagination. - [Get smart lists](https://api.fanvue.com/docs/api-reference/get-smart-lists.md): Get all available smart lists with member counts. - [Get spending reversal data](https://api.fanvue.com/docs/api-reference/get-spending-reversal-data.md): Returns cursor-paginated reversal invoice data for the authenticated creator over a specified time period. Includes refund and chargeback transactions. Pass `fanUuid` to restrict results to a single fan's reversals on this creator. - [Get spending reversal data for a creator](https://api.fanvue.com/docs/api-reference/get-spending-reversal-data-for-a-creator.md): Returns cursor-paginated reversal invoice data for the specified creator over a specified time period. Includes refund and chargeback transactions. - [Get subscriber by user UUID](https://api.fanvue.com/docs/api-reference/get-subscriber-by-user-uuid.md): Returns a single subscriber of the authenticated user by their user UUID, including their subscription details. Returns 404 if the user is not a subscriber. - [Get subscriber events over time](https://api.fanvue.com/docs/api-reference/get-subscriber-events-over-time.md): Returns cursor-paginated subscriber event data for the authenticated creator over a specified time period. - [Get subscriber events over time for a creator](https://api.fanvue.com/docs/api-reference/get-subscriber-events-over-time-for-a-creator.md): Returns cursor-paginated subscriber event data for the specified creator over a specified time period. - [Get subscribers](https://api.fanvue.com/docs/api-reference/get-subscribers.md): Returns a paginated list of users who have subscriptions to the authenticated user. - [Get the agency's five highest-spending fans](https://api.fanvue.com/docs/api-reference/get-the-agencys-five-highest-spending-fans.md): Returns at most five rows: the fans who spent the most across the agency's creators over the requested date range, best first. Not paginated — ranking is done in the database by `earningsView` so that the five rows returned are the five highest by the figure you are showing. - [Get the authenticated user's one-time (app-OTP) payment by invoice number](https://api.fanvue.com/docs/api-reference/get-the-authenticated-users-one-time-app-otp-payment-by-invoice-number.md): `read:self`. Fetches one of the caller's own payments by Fanvue invoice number. 404 for unknown invoice numbers, another buyer's payment, or pre-migration rows. - [Get tips for a creator's post](https://api.fanvue.com/docs/api-reference/get-tips-for-a-creators-post.md): Returns a paginated list of tips received on a specific post owned by the specified creator. - [Get tips for a post](https://api.fanvue.com/docs/api-reference/get-tips-for-a-post.md): Returns a paginated list of tips received on a specific post. Only the post owner can view tips. - [Get top-spending fans](https://api.fanvue.com/docs/api-reference/get-top-spending-fans.md): Returns a paginated list of the top-spending fans for the authenticated creator with their spending totals and message counts. - [Get top-spending fans for a creator](https://api.fanvue.com/docs/api-reference/get-top-spending-fans-for-a-creator.md): Returns a paginated list of the top-spending fans for the specified creator with their spending totals and message counts. - [Get tracking metadata for a user](https://api.fanvue.com/docs/api-reference/get-tracking-metadata-for-a-user.md): Get the custom tracking metadata from a user's most recent impression on a tracking link. - [Get tracking metadata for a user on a creator's tracking link](https://api.fanvue.com/docs/api-reference/get-tracking-metadata-for-a-user-on-a-creators-tracking-link.md): Get the custom tracking metadata from a user's most recent impression on a tracking link for the specified creator. - [Get unread chats, messages, and notifications count](https://api.fanvue.com/docs/api-reference/get-unread-chats-messages-and-notifications-count.md): Returns the count of unread chats, total unread messages, and unread notifications by type for the authenticated user. - [Get unread chats, messages, and notifications count for a creator](https://api.fanvue.com/docs/api-reference/get-unread-chats-messages-and-notifications-count-for-a-creator.md): Returns the count of unread chats, total unread messages, and unread notifications by type for the specified creator. - [Get unsubscribe reasons](https://api.fanvue.com/docs/api-reference/get-unsubscribe-reasons.md): Returns a breakdown of why fans are unsubscribing from the authenticated creator, based on exit-survey data. - [Get unsubscribe reasons for a creator](https://api.fanvue.com/docs/api-reference/get-unsubscribe-reasons-for-a-creator.md): Returns a breakdown of why fans are unsubscribing from the specified creator, based on exit-survey data. - [Get user's media list](https://api.fanvue.com/docs/api-reference/get-users-media-list.md): Returns a paginated list of media items for the authenticated user. - [Get vault folder details](https://api.fanvue.com/docs/api-reference/get-vault-folder-details.md): Returns details of a specific folder by name. - [Grant a consumer access to a creator's media item](https://api.fanvue.com/docs/api-reference/grant-a-consumer-access-to-a-creators-media-item.md): Grant a specific consumer access to a piece of media owned by the specified creator. The grant is idempotent: repeated calls with the same parameters return the existing entitlement. - [Grant a consumer access to a media item](https://api.fanvue.com/docs/api-reference/grant-a-consumer-access-to-a-media-item.md): Grant a specific consumer access to a piece of media owned by the authenticated creator. The grant is idempotent: repeated calls with the same parameters return the existing entitlement. - [Invite a creator](https://api.fanvue.com/docs/api-reference/invite-a-creator.md): Invite a creator to connect to the authenticated user's agency by email. - [Invite a team member](https://api.fanvue.com/docs/api-reference/invite-a-team-member.md): Invite a new team member to the authenticated user's agency by email. - [List a creator's automated messages](https://api.fanvue.com/docs/api-reference/list-a-creators-automated-messages.md): Returns the per-trigger state of the specified creator's automated messages. All triggers are always listed; disabled triggers have `enabled: false` and null content fields. - [List a creator's checkout-link payments](https://api.fanvue.com/docs/api-reference/list-a-creators-checkout-link-payments.md): List checkout-link payments for the specified creator, most recent first, with cursor-based pagination. Filter by your own `clientReferenceId` to reconcile a specific checkout, or by `status`. Webhooks remain the primary delivery mechanism; this endpoint is for reconciliation and recovering missed e… - [List a creator's checkout links](https://api.fanvue.com/docs/api-reference/list-a-creators-checkout-links.md): List the specified creator's checkout links, newest first. Soft-deleted links are excluded; disabled links are included with `status: disabled`. All amounts are integer minor units of the currency (e.g. cents). - [List a creator's flagged media](https://api.fanvue.com/docs/api-reference/list-a-creators-flagged-media.md): List the specified creator's media items flagged by moderation, most recent first: media removed by moderation and media currently under review. Use the `status` query parameter to narrow to one of the two. - [List active subscribers across all agency creators](https://api.fanvue.com/docs/api-reference/list-active-subscribers-across-all-agency-creators.md): Returns a single paginated stream of active subscriptions across every creator the authenticated agency manages, sorted by most recent subscription first. Each row is tagged with `creatorUuid` so consumers can group results by creator without an additional join. - [List agency fan spend by country (cursor-paginated)](https://api.fanvue.com/docs/api-reference/list-agency-fan-spend-by-country-cursor-paginated.md): Returns the agency's paying fans grouped by billing country over the requested date range, ordered by fan count descending, then gross spend, then country code. Fans whose country is unknown are excluded, so shares should be computed against the returned rows rather than against the agency's total f… - [List automated messages](https://api.fanvue.com/docs/api-reference/list-automated-messages.md): Returns the per-trigger state of the authenticated creator's automated messages. All triggers are always listed; disabled triggers have `enabled: false` and null content fields. - [List chats across all agency creators](https://api.fanvue.com/docs/api-reference/list-chats-across-all-agency-creators.md): Returns a single paginated stream of chats across every creator the authenticated agency manages, sorted by most recent activity. Each row is tagged with `creatorUuid` so consumers can group results by creator without an additional join. - [List checkout links](https://api.fanvue.com/docs/api-reference/list-checkout-links.md): List the authenticated creator's checkout links, newest first. Soft-deleted links are excluded; disabled links are included with `status: disabled`. All amounts are integer minor units of the currency (e.g. cents). - [List content collections](https://api.fanvue.com/docs/api-reference/list-content-collections.md): Returns a paginated list of the authenticated creator's content collections. - [List creator vault folders](https://api.fanvue.com/docs/api-reference/list-creator-vault-folders.md): Returns a paginated list of folders in the specified creator's vault. - [List creator's free trial links](https://api.fanvue.com/docs/api-reference/list-creators-free-trial-links.md): List the specified creator's active free trial links, including the shareable URL for each. - [List creator's promotions](https://api.fanvue.com/docs/api-reference/list-creators-promotions.md): List the specified creator's active (non-stopped) subscription promotions. - [List creator's tracking links](https://api.fanvue.com/docs/api-reference/list-creators-tracking-links.md): List tracking links for the specified creator with cursor-based pagination. - [List flagged media](https://api.fanvue.com/docs/api-reference/list-flagged-media.md): List the authenticated creator's media items flagged by moderation, most recent first: media removed by moderation and media currently under review. Use the `status` query parameter to narrow to one of the two. - [List free trial links](https://api.fanvue.com/docs/api-reference/list-free-trial-links.md): List the authenticated creator's active free trial links, including the shareable URL for each. - [List mass messages](https://api.fanvue.com/docs/api-reference/list-mass-messages.md): Returns a paginated list of mass (broadcast) messages sent by the authenticated creator, including delivery and engagement statistics. - [List mass messages for a creator](https://api.fanvue.com/docs/api-reference/list-mass-messages-for-a-creator.md): Returns a paginated list of mass (broadcast) messages sent by the specified creator, including delivery and engagement statistics. - [List media in creator vault folder](https://api.fanvue.com/docs/api-reference/list-media-in-creator-vault-folder.md): Returns a paginated list of media items in the specified creator folder. - [List media in folder](https://api.fanvue.com/docs/api-reference/list-media-in-folder.md): Returns a paginated list of media items in the specified folder. - [List media links](https://api.fanvue.com/docs/api-reference/list-media-links.md): List the authenticated creator's media links, newest first. Soft-deleted links, and links whose media is no longer available, are excluded. All amounts are integer minor units of the currency (e.g. cents). - [List one-time (app-OTP) payments for a developer-owned app](https://api.fanvue.com/docs/api-reference/list-one-time-app-otp-payments-for-a-developer-owned-app.md): Owner-only. Returns one-time payments across all buyers for an app the authenticated developer owns; gated on app ownership. Distinct from `/payments/me` (`read:self`) by design — collapsing them would expose every customer's payments to a buyer token. - [List per-creator-per-day earnings across all agency creators](https://api.fanvue.com/docs/api-reference/list-per-creator-per-day-earnings-across-all-agency-creators.md): Returns a single paginated stream of per-creator-per-day earnings rows across every creator the authenticated agency manages, sorted by most recent day first. Each row is bucketed by `paid_at` (UTC) and tagged with `creatorUuid` so consumers can group results without an additional join. - [List per-creator-per-day new-follower counts across all agency creators](https://api.fanvue.com/docs/api-reference/list-per-creator-per-day-new-follower-counts-across-all-agency-creators.md): Returns a single paginated stream of per-creator-per-day new-follower rows across every creator the authenticated agency manages, sorted by most recent day first. - [List per-creator-per-day subscriber events across all agency creators](https://api.fanvue.com/docs/api-reference/list-per-creator-per-day-subscriber-events-across-all-agency-creators.md): Returns a single paginated stream of per-creator-per-day subscriber event rows across every creator the authenticated agency manages, sorted by most recent day first. - [List promotions](https://api.fanvue.com/docs/api-reference/list-promotions.md): List the authenticated creator's active (non-stopped) subscription promotions. - [List published app store apps](https://api.fanvue.com/docs/api-reference/list-published-app-store-apps.md): Returns the published App Store listings with their marketing metadata (title, tagline, description, pricing type, rating summary, logo and developer). Use `search` to filter and paginate for discovery. - [List team members](https://api.fanvue.com/docs/api-reference/list-team-members.md): Get a list of all team members in the authenticated user's agency. Requires: Agency admin access - [List the authenticated user's one-time (app-OTP) payments for an app](https://api.fanvue.com/docs/api-reference/list-the-authenticated-users-one-time-app-otp-payments-for-an-app.md): `read:self`. Returns only the authenticated user's own one-time payments for an app; filtered to the caller's identity, never owner-gated, so it cannot surface another buyer's data. - [List tracking links](https://api.fanvue.com/docs/api-reference/list-tracking-links.md): List authenticated user's tracking links with cursor-based pagination. - [List users blocked by a creator](https://api.fanvue.com/docs/api-reference/list-users-blocked-by-a-creator.md): List the users the specified creator has blocked, most recently registered first. Supports pagination. - [List users for a creator's tracking link](https://api.fanvue.com/docs/api-reference/list-users-for-a-creators-tracking-link.md): List users associated with a tracking link for the specified creator with cursor-based pagination. - [List users for a tracking link](https://api.fanvue.com/docs/api-reference/list-users-for-a-tracking-link.md): List users associated with a tracking link owned by the authenticated user. - [List vault folders](https://api.fanvue.com/docs/api-reference/list-vault-folders.md): Returns a paginated list of folders in the authenticated user's vault. - [List webhook subscriptions](https://api.fanvue.com/docs/api-reference/list-webhook-subscriptions.md): List the authenticated creator's active webhook subscriptions. - [Mint a publish/unpublish request token](https://api.fanvue.com/docs/api-reference/mint-a-publishunpublish-request-token.md): Mints a short-lived, opaque "request token" the app's creator surface forwards to Fanvue to ask the creator to confirm a publish or unpublish. - [Onboard a creator](https://api.fanvue.com/docs/api-reference/onboard-a-creator.md): Create a pre-filled Fanvue creator signup from the supplied details. - [API Reference](https://api.fanvue.com/docs/api-reference/overview.md): Base URL, authentication, versioning, pagination, errors, rate limits, idempotency and the shared response conventions for the Fanvue API. - [Pin a post](https://api.fanvue.com/docs/api-reference/pin-a-post.md): Pin a post so it appears at the top of the feed. Only the post owner can pin their own content. - [Pin a post for a creator](https://api.fanvue.com/docs/api-reference/pin-a-post-for-a-creator.md): Pin a post on behalf of a creator so it appears at the top of the feed. - [Remove a member from a creator's custom list](https://api.fanvue.com/docs/api-reference/remove-a-member-from-a-creators-custom-list.md): Remove a user from a custom list for the specified creator. - [Remove a member from a custom list](https://api.fanvue.com/docs/api-reference/remove-a-member-from-a-custom-list.md): Remove a user from a custom list. - [Remove media from creator vault folder](https://api.fanvue.com/docs/api-reference/remove-media-from-creator-vault-folder.md): Remove a media item from the specified creator folder. The media item itself is not deleted, only the folder association. - [Remove media from folder](https://api.fanvue.com/docs/api-reference/remove-media-from-folder.md): Remove a media item from the specified folder. The media item itself is not deleted, only the folder association. - [Rename a content collection](https://api.fanvue.com/docs/api-reference/rename-a-content-collection.md): Rename an existing content collection owned by the authenticated creator. - [Rename a creator's custom list](https://api.fanvue.com/docs/api-reference/rename-a-creators-custom-list.md): Update the name of an existing custom list for the specified creator. - [Rename a custom list](https://api.fanvue.com/docs/api-reference/rename-a-custom-list.md): Update the name of an existing custom list. - [Rename creator vault folder](https://api.fanvue.com/docs/api-reference/rename-creator-vault-folder.md): Rename an existing folder in the specified creator's vault. - [Rename vault folder](https://api.fanvue.com/docs/api-reference/rename-vault-folder.md): Rename an existing folder in the authenticated user's vault. - [Repost content](https://api.fanvue.com/docs/api-reference/repost-content.md): Re-surface an existing post by updating its publication date to now. This moves the post back to the top of the feed. Only the post owner can repost their own content. - [Repost content for a creator](https://api.fanvue.com/docs/api-reference/repost-content-for-a-creator.md): Re-surface an existing post on behalf of a creator by updating its publication date to now. This moves the post back to the top of the feed. - [Resolve media UUIDs for a chat message](https://api.fanvue.com/docs/api-reference/resolve-media-uuids-for-a-chat-message.md): Resolves means: for each requested `mediaUuid`, lookup that media only within the specified `messageUuid`, then return its chat media payload (metadata + signed variant URLs) or a per-item error. - [Resolve media UUIDs for a creator chat message](https://api.fanvue.com/docs/api-reference/resolve-media-uuids-for-a-creator-chat-message.md): Resolves means: for each requested `mediaUuid`, lookup that media only within the specified `messageUuid` in this creator conversation, then return its chat media payload (metadata + signed variant URLs) or a per-item error. - [Send a mass message](https://api.fanvue.com/docs/api-reference/send-a-mass-message.md): 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. - [Send a mass message as creator](https://api.fanvue.com/docs/api-reference/send-a-mass-message-as-creator.md): Send a message to multiple users based on selected lists as a creator. If `scheduledAt` (or alias `scheduled_at`) is provided, the message is queued for scheduled delivery instead of being sent immediately. - [Send a message](https://api.fanvue.com/docs/api-reference/send-a-message.md): Send a message to a user in an existing chat conversation. The message can include text, media attachments, and optional pricing for pay-to-view content, or a single third-party GIF (`gif`) in place of text and media. - [Send a message as creator](https://api.fanvue.com/docs/api-reference/send-a-message-as-creator.md): Send a message as a creator in an existing chat conversation. The message can include text, media attachments, and optional pricing for pay-to-view content. - [Send a typing indicator](https://api.fanvue.com/docs/api-reference/send-a-typing-indicator.md): Signal that you are typing (or have stopped typing) in a chat with a user. The signal is delivered to the counterpart's realtime connection and is not persisted, so delivery is best-effort. Send an empty body `{}` (or omit `isTyping`) to indicate you are typing. - [Stop a creator's promotion](https://api.fanvue.com/docs/api-reference/stop-a-creators-promotion.md): Stop the specified creator's promotion so it can no longer be redeemed. Fans who already redeemed it keep their discounted price or trial. - [Stop a promotion](https://api.fanvue.com/docs/api-reference/stop-a-promotion.md): Stop a promotion so it can no longer be redeemed. Fans who already redeemed it keep their discounted price or trial. - [Unblock a user on behalf of a creator](https://api.fanvue.com/docs/api-reference/unblock-a-user-on-behalf-of-a-creator.md): Remove a block on behalf of the specified creator. Unblocking does not restore a subscription that was cancelled when the user was blocked. No-ops if the user is not currently blocked. Returns 404 if the target user does not exist. - [Unpin a post](https://api.fanvue.com/docs/api-reference/unpin-a-post.md): Unpin a post so it returns to normal feed ordering. Only the post owner can unpin their own content. - [Unpin a post for a creator](https://api.fanvue.com/docs/api-reference/unpin-a-post-for-a-creator.md): Unpin a post on behalf of a creator so it returns to normal feed ordering. - [Update a creator scheduled mass message](https://api.fanvue.com/docs/api-reference/update-a-creator-scheduled-mass-message.md): Update a scheduled mass message for the specified creator before it is sent. - [Update a creator's chat with a user](https://api.fanvue.com/docs/api-reference/update-a-creators-chat-with-a-user.md): Update properties of a chat conversation between the specified creator and user (e.g. mark as read, mute, nickname). Used by agency mirror clients to mark conversations as read on behalf of the creator. - [Update a creator's media name, caption and recommended price](https://api.fanvue.com/docs/api-reference/update-a-creators-media-name-caption-and-recommended-price.md): Update the name, caption and/or recommended price of a media item owned by the specified creator. - [Update a post](https://api.fanvue.com/docs/api-reference/update-a-post.md): Update an existing post's properties. Only the post owner can edit their posts. All fields are optional — only provided fields will be updated. - [Update a post for a creator](https://api.fanvue.com/docs/api-reference/update-a-post-for-a-creator.md): Update an existing post on behalf of a creator. All fields are optional — only provided fields will be updated. - [Update a scheduled mass message](https://api.fanvue.com/docs/api-reference/update-a-scheduled-mass-message.md): Update a scheduled mass message before it is sent. - [Update chat properties](https://api.fanvue.com/docs/api-reference/update-chat-properties.md): Update properties of a chat conversation with a user, such as read status, mute status, or nickname. - [Update creator's subscription price](https://api.fanvue.com/docs/api-reference/update-creators-subscription-price.md): Set the specified creator's monthly subscription price, in USD cents (minor units). - [Update media name, caption and recommended price](https://api.fanvue.com/docs/api-reference/update-media-name-caption-and-recommended-price.md): Update the name, caption and/or recommended price of a media item owned by the authenticated user. - [Update media properties](https://api.fanvue.com/docs/api-reference/update-media-properties.md): Update properties of a media item within the specified folder. - [Update subscription price](https://api.fanvue.com/docs/api-reference/update-subscription-price.md): Set the authenticated creator's monthly subscription price, in USD cents (minor units). - [Update team member](https://api.fanvue.com/docs/api-reference/update-team-member.md): Update a team member's properties such as admin status or nickname. Requires: Agency admin access - [App Subscriptions](https://api.fanvue.com/docs/app-store/app-subscriptions.md): Read pricing lifecycle and current-user entitlement for Fanvue App Store apps. - [App Types: Embedded vs Off-Platform](https://api.fanvue.com/docs/app-store/app-types.md): Understand the two app types, their constraints, and how they interact with App Store listing and Fanvue payment rails. - [Credentials](https://api.fanvue.com/docs/app-store/credentials.md): Create an app in the Fanvue Builder to get your Client ID and Secret, and choose your scopes. - [App Store Deeplinks](https://api.fanvue.com/docs/app-store/deeplinks.md): Build links that open your app's listing on Fanvue with a specific pricing plan preselected, or that skip straight to install/checkout. - [Building a Fanvue Embedded App](https://api.fanvue.com/docs/app-store/embedded-apps/integration-guide.md): Register an embedded app, authenticate creators with the @fanvue/builder-sdk SDK, and call the Fanvue API on their behalf — including in the background. - [Embedded Apps](https://api.fanvue.com/docs/app-store/embedded-apps/overview.md): An embedded app lets you embed your website into Fanvue, so creators can use your product without ever leaving the platform. - [Fanvue Apps](https://api.fanvue.com/docs/app-store/introduction.md): Every Fanvue integration is an app: create one to get your API credentials, then build privately, ship off-platform, or list and monetize on the App Store. - [App Store Listing Requirements](https://api.fanvue.com/docs/app-store/listing-requirements.md): What your app needs to be approved for the Fanvue App Store, and to stay listed. Each rule is numbered so review feedback can cite the exact section. - [Publishing Your App](https://api.fanvue.com/docs/app-store/publishing-your-app.md): Everything you need to submit an app to the Fanvue App Store, the review flow, and what the different app states mean. - [App Webhooks](https://api.fanvue.com/docs/app-store/webhooks.md): Receive app.payment.*, app.subscription.*, app.refund.created, and app.dispute.* events for your app's own sales. - [App Payment Events](https://api.fanvue.com/docs/app-store/webhooks/payments.md): app.payment.pending, app.payment.succeeded, and app.payment.failed for your app's own sales. - [App Refunds and Disputes](https://api.fanvue.com/docs/app-store/webhooks/refunds-disputes.md): app.refund.created, the deprecated app.payment.refunded alias, app.dispute.flagged, and app.dispute.created. - [App Subscription Events](https://api.fanvue.com/docs/app-store/webhooks/subscriptions.md): app.subscription.activated and app.subscription.cancel_at_period_end_changed for your app's own subscriptions. - [Implementation Guide](https://api.fanvue.com/docs/authentication/implementation-guide.md): Implement the Fanvue OAuth 2.0 flow with PKCE: authorization, token exchange, and refresh, with code. - [Authentication Overview](https://api.fanvue.com/docs/authentication/overview.md): How the Fanvue API uses OAuth 2.0 so your app can act on a creator's behalf, no API keys required. - [Rate Limits](https://api.fanvue.com/docs/authentication/rate-limits.md): How Fanvue's rate limits work, how the bucket is keyed, the headers to watch, and how to handle a 429 cleanly. - [Scopes](https://api.fanvue.com/docs/authentication/scopes.md): The read and write scopes that control what your app can access, and how to request them. - [Docs for LLMs](https://api.fanvue.com/docs/build-with-ai/docs-for-your-llm.md): Feed the Fanvue docs to your LLM or coding agent via llms.txt and llms-full.txt. - [Build with AI](https://api.fanvue.com/docs/build-with-ai/overview.md): Two ways to put AI to work on Fanvue: operate your account in plain language, or have a coding agent build your integration. - [Build with AI Quick Start](https://api.fanvue.com/docs/build-with-ai/quickstart.md): Connect your coding agent to the Fanvue docs and API, then paste one prompt to scaffold a working app. - [Checkout Attribution](https://api.fanvue.com/docs/checkout/attribution.md): Tie a Fanvue checkout payment back to a record in your own system with client_reference_id and metadata. - [Configuring Checkout Webhooks](https://api.fanvue.com/docs/checkout/configuring.md): Receive checkout events via Zapier, an app, or the Fanvue API, and verify their signatures. - [Checkout Links Page](https://api.fanvue.com/docs/checkout/dashboard.md): How the in-app Checkout links page works: managing links and products, and reading the payments ledger. - [Checkout BNPL Installments](https://api.fanvue.com/docs/checkout/installments.md): installment.paid, installment.failed, and plan.completed for Buy Now, Pay Later (BNPL) financed checkout sales. - [Overview](https://api.fanvue.com/docs/checkout/overview.md): Real-time events for a creator's checkout-link sales: payments, subscriptions, refunds, disputes, BNPL installments, and payouts. - [Checkout Payment Events](https://api.fanvue.com/docs/checkout/payments.md): payment.pending, payment.succeeded, and payment.failed for checkout-link payments. - [Payout Events](https://api.fanvue.com/docs/checkout/payouts.md): payout.paid, a creator-level event fired when a withdrawal is paid out. - [Checkout Refunds and Disputes](https://api.fanvue.com/docs/checkout/refunds-disputes.md): refund.created, dispute.flagged, and dispute.created for checkout-link payments. - [Checkout Subscription Events](https://api.fanvue.com/docs/checkout/subscriptions.md): subscription.activated, subscription.deactivated, and subscription.cancel_at_period_end_changed for checkout-link subscriptions. - [New to APIs?](https://api.fanvue.com/docs/core-concepts/new-to-apis.md): Plain-language definitions of the terms you'll meet in the Fanvue API: OAuth 2.0, Bearer tokens, scopes, redirect URIs, access vs refresh tokens, and KYC. - [Creator Engagement](https://api.fanvue.com/docs/creator/engagement.md): creator.follow.created, creator.post.liked, and creator.post.commented engagement events. - [Creator Fan Status](https://api.fanvue.com/docs/creator/fan-status.md): creator.fan.status_changed for fan mute/unmute and online/offline transitions. - [Creator Messages](https://api.fanvue.com/docs/creator/messages.md): creator.message.received, sent, read, deleted, and reaction events for a creator's direct messages. - [Overview](https://api.fanvue.com/docs/creator/overview.md): Real-time creator.* events for a creator's whole platform activity: payments, subscriptions, messages, engagement, refunds, and disputes. - [Creator Payments](https://api.fanvue.com/docs/creator/payments.md): creator.payment.succeeded for a creator's on-platform sales: posts, messages, media, and tips. - [Creator Refunds and Disputes](https://api.fanvue.com/docs/creator/refunds-disputes.md): creator.refund.created, creator.dispute.flagged, and creator.dispute.created for a creator's on-platform payments. - [Creator Subscriptions](https://api.fanvue.com/docs/creator/subscriptions.md): creator.subscription.activated, deactivated, and cancel_at_period_end_changed for a creator's profile subscriptions. - [n8n Integration](https://api.fanvue.com/docs/integrations/n8n.md): Automate Fanvue workflows with n8n, connecting the API with little or no code. - [First Call](https://api.fanvue.com/docs/introduction/first-call.md): Go from zero to one successful authenticated request to the Fanvue API in about five minutes. - [Fanvue OAuth Quick Start (Next.js App Router)](https://api.fanvue.com/docs/introduction/quick-start.md): Build a working Next.js app with Login with Fanvue using OAuth, starting from the official App Starter. - [Testing Your App](https://api.fanvue.com/docs/introduction/testing-your-app.md): Set up a separate test creator account so you can build and test without touching real data. - [Welcome to the Fanvue API](https://api.fanvue.com/docs/introduction/welcome.md): Build on Fanvue: connect your tools, automate your workflow, and operate creator accounts through one API. - [Fanvue MCP Server](https://api.fanvue.com/docs/mcp-server.md): Turn the AI you already use into a Fanvue co-pilot, reply to fans, pull insights, and manage posts from a single connection. - [Custom tools reference](https://api.fanvue.com/docs/mcp-server/custom-tools.md): Arguments, results and usage for the purpose-built custom tools on the Fanvue MCP server. - [Example prompts](https://api.fanvue.com/docs/mcp-server/prompts.md): Ready-to-use prompts for running your Fanvue account through the MCP. Copy one and adapt it to your account. - [Efficient Chat Sync](https://api.fanvue.com/docs/tutorials/efficient-chat-sync.md): Keep chats in sync without burning your rate limit: receive messages in real time with webhooks, and pull deltas in bulk instead of re-polling. - [Building an Auto-Reply Chatbot](https://api.fanvue.com/docs/tutorials/example-chatbots.md): Build a chatbot that reads a creator's unread chats, drafts an on-brand reply for each one, and sends it back through the Fanvue API. - [Security](https://api.fanvue.com/docs/tutorials/security.md): Secure your Fanvue integration: protect your client secret, scope tokens tightly, verify webhooks, and handle user data responsibly. - [Sending Mass Messages](https://api.fanvue.com/docs/tutorials/sending-mass-messages.md): Send a targeted mass message to a segment of your audience using lists and the messaging API. - [Working with Media](https://api.fanvue.com/docs/tutorials/working-with-media.md): Display Vault and chat media efficiently: request the right variants, avoid N+1 lookups, and handle short-lived media URLs the right way. - [Working with Chats and Messages](https://api.fanvue.com/docs/tutorials/working-with-messages.md): Read a chat correctly: tell pay-to-view, tips, and automated messages apart, check purchase and read status, and attribute a message to a team member. - [Management Strategies](https://api.fanvue.com/docs/versions/management-strategies.md): Strategies for managing Fanvue API versions and upgrading your integration safely. - [API Versioning](https://api.fanvue.com/docs/versions/overview.md): How Fanvue API versioning works and how to pin the version your app uses. - [Delivery, Retries and Idempotency](https://api.fanvue.com/docs/webhooks/delivery-and-idempotency.md): How Fanvue retries failed webhook deliveries, when an endpoint is auto-disabled, and how to deduplicate events safely. - [Webhooks](https://api.fanvue.com/docs/webhooks/index.md): Receive real-time Fanvue events via webhooks. Pick the event family for your integration, then verify every delivery. - [Message Read Webhook](https://api.fanvue.com/docs/webhooks/message-read.md): Webhook event fired when a message you sent is read. - [Message Received Webhook](https://api.fanvue.com/docs/webhooks/message-received.md): Webhook event fired when a creator receives a new message. - [Message Sent Webhook](https://api.fanvue.com/docs/webhooks/message-sent.md): Webhook event fired when a creator sends an outbound message to a fan. - [New Follower Webhook](https://api.fanvue.com/docs/webhooks/new-follower.md): Webhook event fired when a creator gains a new follower. - [New Subscriber Webhook](https://api.fanvue.com/docs/webhooks/new-subscriber.md): Webhook event fired when a creator gains a new subscriber. - [Purchase Received Webhook](https://api.fanvue.com/docs/webhooks/purchase-received.md): Webhook event fired when a purchase is made. - [Verify Webhook Signatures](https://api.fanvue.com/docs/webhooks/signature-verification.md): Validate that an incoming webhook genuinely came from Fanvue before you act on it. - [Subscription Cancelled Webhook](https://api.fanvue.com/docs/webhooks/subscription-cancelled.md): Webhook event fired when a subscription is cancelled, before access ends. - [Subscription Expired Webhook](https://api.fanvue.com/docs/webhooks/subscription-expired.md): Webhook event fired when a subscription ends and access is removed. - [Tip Received Webhook](https://api.fanvue.com/docs/webhooks/tip-received.md): Webhook event fired when a creator receives a tip. - [Webhooks Overview](https://api.fanvue.com/docs/webhooks/webhooks-overview.md): Receive real-time Fanvue events via webhooks: setup, payloads, and delivery. ## OpenAPI Specs - [openapi](https://api.fanvue.com/docs/openapi.json)