# Create leasing events

Create one or more leasing events. Additional event types will be supported in future releases.
Currently only  events are fully supported.  When using the "Assign to User" event type the  object  include an  array.


Endpoint: POST /leasing_events
Version: 1.1.1
Security: BearerAuth

## Request fields (application/json):

  - `events` (array, required)
    List of leasing events to create. Only 1 event is supported at a time.

  - `events.prospect_id` (number, required)
    ID of the prospect associated with the event
    Example: 12345

  - `events.event_type` (string, required)
    Type of leasing event. Currently only "Assign to User" is supported.
    Example: "Assign to User"

  - `events.source` (string)
    Source of the leasing event
    Enum: "Phone Call", "Text Message", "Email", "Facebook Message", "WhatsApp", "Other", "Automation"

  - `events.notes` (string)
    Optional notes for the event
    Example: "Assigning to primary agent"

  - `events.context` (object)
    Additional context for the event.  For "Assign to User" events the following fields are recognized:
-  (array[uuid], required)
-  (boolean) - This will apply the action to all prospects with the same phone number. This is helpful for bulk assigning all units that the prospect is interested in to a single agent in one request.
    Example: {"assignedToUserIds":["1259ef6e-61ee-42cb-b6bd-7fe547569d7c"],"applyActionInBulk":false}

## Response 201 fields (application/json):

  - `id` (integer)
    Unique identifier for the leasing event
    Example: 12345

  - `created_at` (string)
    Timestamp when the leasing event was created
    Example: "2024-10-05T18:53:03.406168Z"

  - `notes` (string)
    Optional notes about the leasing event
    Example: "Reschedule"

  - `prospect` (integer)
    ID of the associated prospect
    Example: 12345

  - `planned_date_time` (string)
    Planned date and time for the leasing event
    Example: "2024-10-05T18:53:03.406168Z"

  - `source` (string)
    Source of the leasing event
    Enum: "Phone Call", "Text Message", "Email", "Facebook Message", "WhatsApp", "Other", "Showing Scheduler", "Automation"

  - `event_type` (string)
    Type of the leasing event
    Enum: "New", "Contacted, Awaiting Information", "Showing Desired", "Showing Scheduled", "Showing Complete", "Missed Showing", "Ghosting", "Application Sent to Prospect", "Application Received", "Application Pending", "Application in Owner Review", "Application Approved", "Withdrawn", "Application Rejected", "Prescreen Submitted", "Prescreen Rejected - Self reported credit", "Prescreen Rejected - Self reported income", "Prescreen Rejected - ID Verification", "Prescreen Approved", "Looking too early", "Lease out for signing", "Lease Signed", "Deposit Received", "Move-in Scheduled", "Moved In", "Unit of Interest Unavailable", "Not Interested", "Duplicate Lead", "Still Deciding", "HOA Application Sent To Prospect", "HOA Application Submitted", "HOA Application Approved", "HOA Application Rejected", "Showing Failed", "Showing Canceled", "Showing Confirmed", "Awaiting PM Response", "PM Response", "Arrived for Showing", "Showing Started", "Log Note", "Assign to User", "Blocklist Prospect", "Unblock Prospect", "Reassign Showing"

  - `next_follow_up` (string)
    Timestamp for the next follow-up
    Example: "2024-10-05T18:53:03.406168Z"

  - `deleted` (boolean)
    Flag indicating if the leasing event is deleted

  - `created_by` (string)
    Identifier of the user who created the event
    Example: "12345"

  - `context` (object)
    Additional context information for the event. Structure varies based on event_type.
    Example: {"assignedToUserIds":["1259ef6e-61ee-42cb-b6bd-7fe547569d7c"],"createdByUserRole":"Property Manager","previousAssignedToUserIds":[]}

## Response 400 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]

## Response 401 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]

## Response 500 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]