Create Lease: Propertyware | Propexo

curl -X POST https://api.propexo.com/v1/leases/propertyware/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "property_id": "string",
  "unit_id": "string",
  "primary_contact_id": "string",
  "tenants": [
    {
      "id": "string"
    }
  ],
  "start_date": "2024-01-15T09:30:00Z",
  "end_date": "2024-01-15T09:30:00Z"
}'

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "property_id": "string",
    "unit_id": "string",
    "primary_contact_id": "string",
    "tenants": [
      {
        "id": "string"
      }
    ],
    "start_date": "2024-01-15T09:30:00Z",
    "end_date": "2024-01-15T09:30:00Z",
    "scheduled_move_in_date": "2024-01-15T09:30:00Z",
    "scheduled_move_out_date": "2024-01-15T09:30:00Z",
    "status": "Draft"
  }
}

Create Lease: Propertyware

Method
createLease

Create Lease: Propertyware | Method | |---| | createLease |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

property_idstringRequired

The Propexo unique identifier for the property

unit_idstringRequired

The Propexo unique identifier for the unit

primary_contact_idstringRequired

The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo

tenantslist of objectsRequired

An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID

start_datestringRequiredformat: "date-time"

The start date associated with the lease

end_datestringRequiredformat: "date-time"

The end date associated with the lease

scheduled_move_in_datestringOptionalformat: "date-time"

The move-in date associated with the lease

scheduled_move_out_datestringOptionalformat: "date-time"

The move-out date associated with the lease

statusenumOptional

The status associated with the lease

Allowed values:

Response

Successful response

metaobject

resultobject

Authentication

Request

Response

Errors