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

# Register interest in an experience, with optional intake

> Creates a non-committing interest: a concierge conversation and a place for the member's dates, with no points debited and no inventory held. Dietary, allergy and accessibility answers are not accepted here - send them to the intake endpoint, which does not store them.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/interests
openapi: 3.0.3
info:
  description: Public REST API for embedding Expys experiences into a client app.
  title: Expys API
  version: 1.4.0
servers:
  - url: https://api.expys.com
    description: >-
      Expys API. Sandbox and live share this host; the environment is selected
      by which key you exchange for a member token, not by the URL.
security: []
paths:
  /v1/interests:
    post:
      tags:
        - Interests
      summary: Register interest in an experience, with optional intake
      description: >-
        Creates a non-committing interest: a concierge conversation and a place
        for the member's dates, with no points debited and no inventory held.
        Dietary, allergy and accessibility answers are not accepted here - send
        them to the intake endpoint, which does not store them.
      operationId: createInterest
      parameters:
        - description: >-
            Optional client-generated key (<=255 chars). A retried POST carrying
            the same key replays the original response instead of acting twice;
            reusing a key with a different body returns 409.
          in: header
          name: Idempotency-Key
          required: false
          schema:
            maxLength: 255
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInterestRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInterestResponse'
          description: Response for status 201
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '401':
          description: Authentication is missing or invalid.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '403':
          description: Authenticated, but not permitted to access this resource.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '429':
          description: Rate limit exceeded; honor the Retry-After header.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '500':
          description: An unexpected server error occurred.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
      security:
        - ApiKeyBearer: []
        - ApiKeyHeader: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST https://api.expys.com/v1/interests \
              -H "Authorization: Bearer YOUR_MEMBER_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "adults": 0,
                "blackoutDates": [
                  "string"
                ],
                "children": 0,
                "contactMethod": "APP_CHAT",
                "contactWindow": "MORNING",
                "externalUserID": "string",
                "occasion": "BIRTHDAY",
                "offer": "string",
                "phone": "string",
                "preferredDates": [
                  "string"
                ]
              }'
components:
  schemas:
    CreateInterestRequest:
      properties:
        adults:
          type: integer
        blackoutDates:
          items:
            description: A calendar date, YYYY-MM-DD. Not a datetime.
            type: string
          type: array
        children:
          type: integer
        contactMethod:
          enum:
            - APP_CHAT
            - SMS
            - EMAIL
            - PHONE
          type: string
        contactWindow:
          enum:
            - MORNING
            - AFTERNOON
            - EVENING
            - ANYTIME
          type: string
        externalUserID:
          type: string
        occasion:
          enum:
            - BIRTHDAY
            - ANNIVERSARY
            - ENGAGEMENT
            - WEDDING
            - GRADUATION
            - PROMOTION
            - BUSINESS
            - OTHER
          type: string
        offer:
          type: string
        phone:
          type: string
        preferredDates:
          items:
            description: A calendar date, YYYY-MM-DD. Not a datetime.
            type: string
          type: array
      required:
        - offer
      type: object
    CreateInterestResponse:
      properties:
        conversationId:
          nullable: true
          type: string
        createdAt:
          type: string
        id:
          type: string
        intake:
          $ref: '#/components/schemas/Intake'
        offer:
          type: string
        status:
          type: string
      required:
        - conversationId
        - createdAt
        - id
        - intake
        - offer
        - status
      type: object
    Intake:
      nullable: true
      properties:
        adults:
          nullable: true
          type: integer
        blackoutDates:
          items:
            type: string
          type: array
        children:
          nullable: true
          type: integer
        contactMethod:
          nullable: true
          type: string
          enum:
            - APP_CHAT
            - SMS
            - EMAIL
            - PHONE
        contactWindow:
          nullable: true
          type: string
          enum:
            - MORNING
            - AFTERNOON
            - EVENING
            - ANYTIME
        occasion:
          nullable: true
          type: string
          enum:
            - BIRTHDAY
            - ANNIVERSARY
            - ENGAGEMENT
            - WEDDING
            - GRADUATION
            - PROMOTION
            - BUSINESS
            - OTHER
        phone:
          nullable: true
          type: string
        phoneVerified:
          type: boolean
        preferredDates:
          items:
            type: string
          type: array
        sensitiveDetailsSentAt:
          nullable: true
          type: string
      required:
        - adults
        - blackoutDates
        - children
        - contactMethod
        - contactWindow
        - occasion
        - phone
        - phoneVerified
        - preferredDates
        - sensitiveDetailsSentAt
      type: object
  securitySchemes:
    ApiKeyBearer:
      description: Org-API-Key as a Bearer token.
      scheme: bearer
      type: http
    ApiKeyHeader:
      description: Org-API-Key as a header.
      in: header
      name: x-api-key
      type: apiKey

````