# Create a showing

Create a new showing for a unit. This endpoint handles both new showings and rescheduling of existing showings.

## Prospect Types
- : Regular prospect who needs to complete prescreening
- : Real estate agent who needs to provide a valid agent token

## Prescreening
For self prospects, the system will automatically run prescreening based on the unit's prescreen template.
If prescreening fails, the showing will not be created and an appropriate error will be returned.

## Agent Tokens
For agent prospects, a valid 6-character agent token must be provided in the  field.

## Showing Methods
The  field allows specifying the preferred showing method:
- "Accompanied": Agent-guided showing
- "Self Guided": Self-guided showing
- "Remote Guided": Remote-guided showing
- "Remote Guided with Gated Access": Remote-guided showing with gate access


Endpoint: POST /showings/create
Version: 1.1.1
Security: BearerAuth

## Request fields (application/json):

  - `unitId` (number, required)
    ID of the unit to schedule the showing for
    Example: 12345

  - `plannedForTime` (string, required)
    Planned date and time for the showing (ISO 8601 format)
    Example: "2024-03-15T10:00:00Z"

  - `prospectData` (object, required)
    Prospect information and prescreening data

  - `prospectData.firstName` (string, required)
    Prospect's first name
    Example: "John"

  - `prospectData.lastName` (string, required)
    Prospect's last name
    Example: "Doe"

  - `prospectData.email` (string, required)
    Prospect's email address
    Example: "john.doe@example.com"

  - `prospectData.phone` (string, required)
    Prospect's phone number (10 digits)
    Example: "5551234567"

  - `prospectData.creditScore` (string, required)
    Prospect's credit score range
    Example: "700+"

  - `prospectData.income` (string, required)
    Prospect's household monthly income range
    Example: "$5000-$6000/month"

  - `prospectData.questionAnswers` (array, required)
    Answers to prescreening questions

  - `prospectData.questionAnswers.question` (string, required)
    The question text
    Example: "Do you have a housing voucher (e.g. Section 8)?"

  - `prospectData.questionAnswers.fixedQuestionType` (string)
    Fixed question type identifier
    Example: "housing_voucher"

  - `prospectData.questionAnswers.type` (string, required)
    Question type
    Example: "yes_no"

  - `prospectData.questionAnswers.answer` (boolean, required)
    The prospect's answer to the question

  - `prospectData.prospectType` (string, required)
    Type of prospect
    Enum: "Self", "Agent"

  - `prospectData.voucherHolder` (boolean)
    Whether the prospect holds a housing voucher

  - `prospectData.licenseNumber` (string)
    License number (for agent prospects)
    Example: "ABC123"

  - `prospectData.notes` (string)
    Additional notes about the prospect
    Example: "Interested in 2BR units"

  - `agentTk` (string)
    Agent token (required for agent prospects, must be 6 characters)
    Example: "ABC123"

  - `desiredShowingMethod` (string)
    Preferred showing method
    Enum: "Accompanied", "Self Guided", "Remote Guided", "Remote Guided with Gated Access"

  - `files` (array)
    Array of file paths for uploaded documents
    Example: ["documents/id-verification.pdf"]

  - `livenessResult` (object)
    Liveness verification result from ID verification

  - `rescheduleEvent` (string,number)
    ID of the event to reschedule (if rescheduling an existing showing)
    Example: 67890

## Response 200 fields (application/json):

  - `statusText` (string, required)
    Success status message
    Example: "success"

## Response 400 fields (application/json):

  - `message` (string, required)
    Error message

## Response 500 fields (application/json):

  - `message` (string, required)
    Error message