> ## Documentation Index > Fetch the complete documentation index at: https://docs.fanfare.io/llms.txt > Use this file to discover all available pages before exploring further. # POST /experiences/{experienceId}/enter > Enter an experience ## OpenAPI ````yaml /api/openapi/consumer-api.json post /experiences/{experienceId}/enter openapi: 3.1.0 info: description: Consumer API for Fanfare title: Fanfare Consumer API version: 1.0.0 servers: - description: Production url: https://consumer.fanfare.io/api - description: Local development url: http://localhost:4802 security: [] paths: /experiences/{experienceId}/enter: post: tags: - Experiences description: Enter an experience operationId: postExperiencesByExperienceIdEnter parameters: - in: path name: experienceId required: true schema: type: string responses: '200': content: application/json: schema: properties: enteredAt: type: string experience: properties: accessCode: anyOf: - type: string - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' currencyCode: minLength: 1 type: string hasProtectedSequences: type: boolean i18n: anyOf: - additionalProperties: additionalProperties: type: string propertyNames: type: string type: object propertyNames: type: string type: object - type: 'null' id: format: uuid type: string name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' product: anyOf: - properties: archived: type: boolean createdAt: format: date-time type: string createdBy: type: string defaultVariantId: anyOf: - format: uuid type: string - type: 'null' description: anyOf: - type: string - type: 'null' handle: anyOf: - type: string - type: 'null' id: format: uuid type: string metadata: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' name: minLength: 1 type: string organizationId: format: uuid type: string primaryExternalId: anyOf: - type: string - type: 'null' primaryLastSyncedAt: anyOf: - format: date-time type: string - type: 'null' primarySourceVendor: anyOf: - type: string - type: 'null' primarySyncSource: anyOf: - properties: archived: type: boolean createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string lastSyncedAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sourceData: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' syncSource: type: string syncSourceId: type: string syncStatus: anyOf: - enum: - PENDING - SUCCESS - FAILED - type: 'null' default: PENDING updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - syncSource - syncSourceId type: object - type: 'null' primarySyncSourceId: anyOf: - type: string - type: 'null' productMediaAssets: anyOf: - items: properties: id: format: uuid type: string mediaAsset: properties: altText: anyOf: - type: string - type: 'null' archived: type: boolean createdAt: format: date-time type: string createdBy: type: string description: anyOf: - type: string - type: 'null' id: format: uuid type: string mimeType: enum: - image/jpeg - image/jpg - image/png - image/gif - image/webp - video/mp4 - video/webm - video/quicktime name: minLength: 1 type: string organizationId: format: uuid type: string publicUrl: anyOf: - format: uri type: string - type: 'null' sourceUrl: anyOf: - format: uri type: string - type: 'null' thumbnailUrl: anyOf: - format: uri type: string - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' uploadUrl: anyOf: - format: uri type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - name - mimeType type: object mediaAssetId: format: uuid type: string organizationId: format: uuid type: string position: minimum: 0 type: integer productId: format: uuid type: string purpose: type: string required: - id - organizationId - position - purpose - productId - mediaAssetId - mediaAsset type: object type: array - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' url: format: uri type: string variants: anyOf: - items: properties: options: items: properties: optionId: format: uuid type: string optionName: type: string value: type: string valueId: format: uuid type: string required: - optionId - optionName - valueId - value type: object type: array archived: type: boolean createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string inventoryPolicy: enum: - untracked - deny - continue inventoryQuantity: type: integer metadata: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' organizationId: format: uuid type: string price: pattern: ^\d{1,12}(\.\d{1,8})?$ type: string primaryExternalId: anyOf: - type: string - type: 'null' primaryLastSyncedAt: anyOf: - format: date-time type: string - type: 'null' primarySourceVendor: anyOf: - type: string - type: 'null' primarySyncSourceId: anyOf: - type: string - type: 'null' productId: format: uuid type: string sku: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - productId - sku - price - inventoryQuantity - inventoryPolicy - options type: object type: array - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - name - url type: object - type: 'null' products: anyOf: - items: properties: experienceId: format: uuid type: string id: format: uuid type: string isPrimary: type: boolean organizationId: format: uuid type: string position: type: number product: anyOf: - properties: archived: type: boolean createdAt: format: date-time type: string createdBy: type: string defaultVariantId: anyOf: - format: uuid type: string - type: 'null' description: anyOf: - type: string - type: 'null' handle: anyOf: - type: string - type: 'null' id: format: uuid type: string metadata: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' name: minLength: 1 type: string organizationId: format: uuid type: string primaryExternalId: anyOf: - type: string - type: 'null' primaryLastSyncedAt: anyOf: - format: date-time type: string - type: 'null' primarySourceVendor: anyOf: - type: string - type: 'null' primarySyncSource: anyOf: - properties: archived: type: boolean createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string lastSyncedAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sourceData: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' syncSource: type: string syncSourceId: type: string syncStatus: anyOf: - enum: - PENDING - SUCCESS - FAILED - type: 'null' default: PENDING updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - syncSource - syncSourceId type: object - type: 'null' primarySyncSourceId: anyOf: - type: string - type: 'null' productMediaAssets: anyOf: - items: properties: id: format: uuid type: string mediaAsset: properties: altText: anyOf: - type: string - type: 'null' archived: type: boolean createdAt: format: date-time type: string createdBy: type: string description: anyOf: - type: string - type: 'null' id: format: uuid type: string mimeType: enum: - image/jpeg - image/jpg - image/png - image/gif - image/webp - video/mp4 - video/webm - video/quicktime name: minLength: 1 type: string organizationId: format: uuid type: string publicUrl: anyOf: - format: uri type: string - type: 'null' sourceUrl: anyOf: - format: uri type: string - type: 'null' thumbnailUrl: anyOf: - format: uri type: string - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' uploadUrl: anyOf: - format: uri type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - name - mimeType type: object mediaAssetId: format: uuid type: string organizationId: format: uuid type: string position: minimum: 0 type: integer productId: format: uuid type: string purpose: type: string required: - id - organizationId - position - purpose - productId - mediaAssetId - mediaAsset type: object type: array - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' url: format: uri type: string variants: anyOf: - items: properties: options: items: properties: optionId: format: uuid type: string optionName: type: string value: type: string valueId: format: uuid type: string required: - optionId - optionName - valueId - value type: object type: array archived: type: boolean createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string inventoryPolicy: enum: - untracked - deny - continue inventoryQuantity: type: integer metadata: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' organizationId: format: uuid type: string price: pattern: ^\d{1,12}(\.\d{1,8})?$ type: string primaryExternalId: anyOf: - type: string - type: 'null' primaryLastSyncedAt: anyOf: - format: date-time type: string - type: 'null' primarySourceVendor: anyOf: - type: string - type: 'null' primarySyncSourceId: anyOf: - type: string - type: 'null' productId: format: uuid type: string sku: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - productId - sku - price - inventoryQuantity - inventoryPolicy - options type: object type: array - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - name - url type: object - type: 'null' productId: format: uuid type: string productVariant: anyOf: - properties: archived: type: boolean createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string inventoryPolicy: enum: - untracked - deny - continue inventoryQuantity: type: integer metadata: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: 'null' organizationId: format: uuid type: string price: pattern: ^\d{1,12}(\.\d{1,8})?$ type: string primaryExternalId: anyOf: - type: string - type: 'null' primaryLastSyncedAt: anyOf: - format: date-time type: string - type: 'null' primarySourceVendor: anyOf: - type: string - type: 'null' primarySyncSourceId: anyOf: - type: string - type: 'null' productId: format: uuid type: string sku: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - productId - sku - price - inventoryQuantity - inventoryPolicy type: object - type: 'null' productVariantId: anyOf: - format: uuid type: string - type: 'null' required: - id - organizationId - experienceId - productId - isPrimary - position type: object type: array - type: 'null' sequences: anyOf: - items: properties: appointments: anyOf: - items: properties: bufferMinutes: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' id: format: uuid type: string locationId: anyOf: - format: uuid type: string - type: 'null' maxCapacityPerSlot: anyOf: - type: number - type: 'null' openAt: anyOf: - format: date-time type: string - type: 'null' slotDurationMinutes: anyOf: - type: number - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string required: - id - timeZone type: object type: array - type: 'null' auctions: anyOf: - items: properties: auctionType: default: english enum: - english - dutch autoExtendSeconds: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' currencyCode: minLength: 1 type: string floorPrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' id: format: uuid type: string minBidIncrement: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' openAt: anyOf: - format: date-time type: string - type: 'null' priceDropAmount: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' priceDropIntervalSeconds: anyOf: - type: number - type: 'null' quantity: anyOf: - type: number - type: 'null' reservePrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' settleAt: format: date-time type: string startPrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string required: - id - timeZone - settleAt - currencyCode type: object type: array - type: 'null' audienceId: anyOf: - format: uuid type: string - type: 'null' draws: anyOf: - items: properties: capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' continueSelectingUntilCompleted: anyOf: - type: boolean - type: 'null' drawAt: format: date-time type: string id: format: uuid type: string loyaltyBiasEnabled: type: boolean openAt: anyOf: - format: date-time type: string - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string required: - id - timeZone - drawAt type: object type: array - type: 'null' experienceId: anyOf: - format: uuid type: string - type: 'null' id: format: uuid type: string name: minLength: 1 type: string priority: type: number productSelectionMode: anyOf: - enum: - USER_SELECTED - SYSTEM_ASSIGNED - type: 'null' queues: anyOf: - items: properties: admissionExpirationSeconds: anyOf: - type: number - type: 'null' admitRate: type: number capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' id: format: uuid type: string loyaltyBiasEnabled: type: boolean maxAdmissions: anyOf: - type: number - type: 'null' openAt: anyOf: - format: date-time type: string - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string required: - id - timeZone - admitRate type: object type: array - type: 'null' waitlist: anyOf: - properties: capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' id: format: uuid type: string statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' required: - id type: object - type: 'null' required: - id - name - priority type: object type: array - type: 'null' theme: anyOf: - properties: background: type: string danger: type: string fontFamily: type: string fontHeading: type: string headerImageUrl: format: uri type: string logoUrl: format: uri type: string muted: type: string primary: type: string secondary: type: string success: type: string surface: type: string text: type: string variant: enum: - default - retro - rounded - clean warning: type: string required: [] type: object - type: 'null' timeZone: minLength: 1 type: string required: - id - name - timeZone - currencyCode type: object experienceId: type: string required: - experienceId - enteredAt - experience type: object description: Entered experience '400': content: application/json: schema: properties: error: const: validation_error issues: items: properties: expected: type: string kind: type: string message: type: string path: items: properties: input: {} key: type: string origin: type: string type: type: string required: - type - origin - input - key type: object type: array received: type: string type: type: string required: - kind - type - expected - received - message - path type: object type: array required: - error - issues type: object description: Bad Request - Invalid input schema '401': content: application/json: schema: properties: error: type: string required: - error type: object description: Unauthorized - Authentication required '403': content: application/json: schema: properties: error: type: string required: - error type: object description: Forbidden - User must be authenticated '500': content: application/json: schema: properties: error: type: string required: - error type: object description: Internal server error ````