Skip to main content
POST
Mint a publish/unpublish request token
Required scope
  • write:experience — Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change.

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"

Body

application/json
action
enum<string>
required
Available options:
publish
externalExperienceId
string
required
Minimum string length: 1
title
string
required
description
string
required
proposedAccessMode
enum<string>
required
Available options:
FREE,
SUBSCRIPTION,
PAID,
HIDDEN
deliveryMode
enum<string>
required
Available options:
EMBEDDED,
EXTERNAL
appUuid
string<uuid>
required
imageUrl
string<uri> | null

Public https URL of the experience cover image. Fanvue downloads and re-hosts it when the creator confirms the publish.

Maximum string length: 2048
Example:

"https://example.com/covers/launch-your-page.jpg"

externalUrl
string | null

Response

The minted request token

token
string
required

The opaque request token to forward to the creator surface for confirmation.

Example:

"req_2f1c…"