> ## Documentation Index
> Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Unpublish one of your experiences for this creator

> Takes an experience your app published off the creator's profile. The row is kept and the same `externalExperienceId` can be published again.

    Fans holding paid access answer 409 with the impact: retry with `acknowledgePaidImpact` and the impact echoed as `acknowledgedImpact` to proceed, unless fans hold live recurring access, which blocks it outright. A POST rather than a DELETE: the body names your app and carries the acknowledgement, and the row survives to be published again.

> [!NOTE]
>
> **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.


## OpenAPI

````yaml /openapi-v1.json post /v1/experiences/{experienceUuid}/unpublish
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers:
  - url: https://api.fanvue.com
security: []
paths:
  /v1/experiences/{experienceUuid}/unpublish:
    post:
      summary: Unpublish one of your experiences for this creator
      description: >-
        Takes an experience your app published off the creator's profile. The
        row is kept and the same `externalExperienceId` can be published again.

            Fans holding paid access answer 409 with the impact: retry with `acknowledgePaidImpact` and the impact echoed as `acknowledgedImpact` to proceed, unless fans hold live recurring access, which blocks it outright. A POST rather than a DELETE: the body names your app and carries the acknowledgement, and the row survives to be published again.
      operationId: unpublishExperience
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
            example: 00000000-0000-4000-8000-000000000010
          required: true
          name: experienceUuid
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appUuid:
                  type: string
                  format: uuid
                  description: Your app's UUID.
                acknowledgePaidImpact:
                  type: boolean
                  description: >-
                    Set to `true` on a retry to accept the paid impact a
                    previous attempt answered 409 with. Send the 409's `impact`
                    alongside as `acknowledgedImpact`.
                  example: true
                acknowledgedImpact:
                  allOf:
                    - $ref: '#/components/schemas/ExperiencePaidImpact'
                    - description: >-
                        The `impact` the previous 409 reported, echoed back
                        verbatim.
              required:
                - appUuid
      responses:
        '204':
          description: Experience unpublished
        '400':
          description: >-
            Bad Request - API version not supported OR validation failed OR
            invalid UUID
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/InvalidUuidError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          description: >-
            Three refusals, told apart by their shape. A named refusal the app
            can act on carries `error` and `message`: the creator is outside the
            fan-experiences rollout, has not installed the app, the app cannot
            carry experiences, or Fanvue has removed this experience
            (`experience_suspended`, lifted on reinstatement). The token lacking
            `write:experience` carries `error` alone (`Insufficient scopes`).
            The app named in `appUuid` not being the calling app carries
            `message` alone (`Forbidden`).
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ExperienceWriteError'
                  - type: object
                    properties:
                      error:
                        type: string
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                    additionalProperties: false
        '404':
          description: Experience not found, or not your app's
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '409':
          description: >-
            Fans have paid for access this change takes away.
            `paid_impact_acknowledgement_required` is retried with the
            acknowledgement fields; `blocked_active_subscriptions` cannot
            proceed from the API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperiencePaidImpactConflict'
              example:
                error: paid_impact_acknowledgement_required
                message: >-
                  Fans have paid for access this would take away; acknowledge
                  the paid impact to proceed.
                impact:
                  affectedFanCount: 3
                  activeSubscriptionCount: 0
                  pendingSubscriptionInvoiceCount: 0
                  oneTimePurchaseCount: 3
                  pendingPurchaseCount: 0
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
        '502':
          description: The write could not be completed against the upstream
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '503':
          description: Developer API upstream is not configured
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      security:
        - BearerAuth:
            - write:experience
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    ExperiencePaidImpact:
      type: object
      properties:
        affectedFanCount:
          type: integer
          minimum: 0
          description: >-
            Distinct fans holding paid access right now, across subscriptions
            and purchases.
          example: 3
        activeSubscriptionCount:
          type: integer
          minimum: 0
          description: >-
            Subscriptions that still grant access. Any at all blocks the change
            outright.
          example: 0
        pendingSubscriptionInvoiceCount:
          type: integer
          minimum: 0
          description: >-
            In-flight initial subscription charges. Block, like a settled
            subscription.
          example: 0
        oneTimePurchaseCount:
          type: integer
          minimum: 0
          description: >-
            Distinct fans holding a settled one-off purchase. Needs
            acknowledging.
          example: 3
        pendingPurchaseCount:
          type: integer
          minimum: 0
          description: >-
            In-flight one-off purchase attempts. Need acknowledging, like a
            settled purchase.
          example: 0
      required:
        - affectedFanCount
        - activeSubscriptionCount
        - pendingSubscriptionInvoiceCount
        - oneTimePurchaseCount
        - pendingPurchaseCount
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
    InvalidUuidError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      description: Invalid UUID format provided
    ExperienceWriteError:
      type: object
      properties:
        error:
          type: string
          enum:
            - fan_experiences_not_enabled
            - app_not_installed
            - app_not_available
            - experience_suspended
          description: >-
            `fan_experiences_not_enabled`: the creator is outside the
            fan-experiences rollout. `app_not_installed`: the creator has not
            installed your app. `app_not_available`: your app is not approved,
            suspended or archived, so it cannot carry experiences.
            `experience_suspended`: Fanvue removed this experience for a policy
            reason; it refuses writes until Fanvue reinstates it.
        message:
          type: string
      required:
        - error
        - message
    ExperiencePaidImpactConflict:
      type: object
      properties:
        error:
          type: string
          enum:
            - paid_impact_acknowledgement_required
            - blocked_active_subscriptions
          description: >-
            `paid_impact_acknowledgement_required`: fans have paid for access
            this change takes away; retry with `acknowledgePaidImpact: true` and
            the `impact` below as `acknowledgedImpact`.
            `blocked_active_subscriptions`: fans hold live recurring access, so
            the change cannot proceed from the API at all.
        message:
          type: string
        impact:
          $ref: '#/components/schemas/ExperiencePaidImpact'
      required:
        - error
        - message
        - impact
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        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.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            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.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.