Create/Update Leases And Tenants

POST

leases

create

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

You must specify either a unit_id or unit_external_ref for your lease.

If the corresponding unit record does not exist, you must create it separately via the relevant unit/property endpoints.

Authorization

string

default:"none"

required

The authentication token for your request

Body

lease

object

default:"none"

required

The parameters for the lease to update or create.

Show lease

identifier

string

default:"none"

A unique identifier for the lease.

This will be used when determining whether a lease needs to be updated or created.

If this matches a lease that lease will be updated, otherwise a new one will be created.

The identifier for a lease can not be updated once it has been set.

When creating a new lease, a random, unique identifier will be set.

Any value passed in this request will only be used for finding an existing lease.

start_date

string

default:"none"

The start date of the lease.

end_date

string

default:"none"

The end date of the lease.

move_in_date

string

default:"none"

The move in date of the lease.

unit_id

string

default:"none"

The id of the property associated with the lease.

unit_external_ref

string

default:"none"

The id of the property associated with the lease.

is_furnished

boolean

default:"none"

Whether the lease is for a furnished or unfurnished property.

minimum_days_notice

integer

default:"none"

Minimum days of notice that must be given to break the lease agreement.

deposit

float

default:"none"

The deposit amount for the lease.

rent

float

default:"none"

The rent amount for the lease.

tenants

[object]

default:"none"

A list of tenants to be associated with the created or updated lease.

Show tenant

email_address

string

default:"none"

The email adddress of the tenant.

first_name

string

default:"none"

The first name of the tenant.

last_name

string

default:"none"

The last name of the tenant.

external_ref

string

default:"none"

The external reference of the tenant.

This is typically an identifier you may use for person records in your own system.

phone_number

string

default:"none"

The phone number of the tenant.

Response

Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.

Status Code - 400

Missing Authorization header

{
   "error": {
    "type": "missing_authorization",
    "message": "Your request does not include an 'Authorization' header with a bearer token for your account."
  }
}

Status Code - 401

Expired Authorization header bearer token value

{
   "error": {
    "type": "expired_token",
    "message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
  }
}

Status Code - 401

Invalid Authorization header bearer token value

{
   "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}

Status Code - 400

Returned if neither a unit id or a unit external reference is passed in the request body

No unit specified for the lease

{
   "error": {
    "type": "no_unit",
    "message": "No unit id or unit external reference provided."
  }
}

Status Code - 400

Returned if a unit with the specified unit id or unit external reference could not be retrieved

Unit to use for lease not found

{
   "error": {
    "type": "unit_not_found",
    "message": "No unit with the provided unit id or unit external reference."
  }
}

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

POST

leases

create

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

You must specify either a unit_id or unit_external_ref for your lease.

If the corresponding unit record does not exist, you must create it separately via the relevant unit/property endpoints.

Authorization

string

default:"none"

required

The authentication token for your request

Body

lease

object

default:"none"

required

The parameters for the lease to update or create.

Show lease

identifier

string

default:"none"

A unique identifier for the lease.

This will be used when determining whether a lease needs to be updated or created.

If this matches a lease that lease will be updated, otherwise a new one will be created.

The identifier for a lease can not be updated once it has been set.

When creating a new lease, a random, unique identifier will be set.

Any value passed in this request will only be used for finding an existing lease.

start_date

string

default:"none"

The start date of the lease.

end_date

string

default:"none"

The end date of the lease.

move_in_date

string

default:"none"

The move in date of the lease.

unit_id

string

default:"none"

The id of the property associated with the lease.

unit_external_ref

string

default:"none"

The id of the property associated with the lease.

is_furnished

boolean

default:"none"

Whether the lease is for a furnished or unfurnished property.

minimum_days_notice

integer

default:"none"

Minimum days of notice that must be given to break the lease agreement.

deposit

float

default:"none"

The deposit amount for the lease.

rent

float

default:"none"

The rent amount for the lease.

tenants

[object]

default:"none"

A list of tenants to be associated with the created or updated lease.

Show tenant

email_address

string

default:"none"

The email adddress of the tenant.

first_name

string

default:"none"

The first name of the tenant.

last_name

string

default:"none"

The last name of the tenant.

external_ref

string

default:"none"

The external reference of the tenant.

This is typically an identifier you may use for person records in your own system.

phone_number

string

default:"none"

The phone number of the tenant.

Response

Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.

Status Code - 400

Missing Authorization header

{
   "error": {
    "type": "missing_authorization",
    "message": "Your request does not include an 'Authorization' header with a bearer token for your account."
  }
}

Status Code - 401

Expired Authorization header bearer token value

{
   "error": {
    "type": "expired_token",
    "message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
  }
}

Status Code - 401

Invalid Authorization header bearer token value

{
   "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}

Status Code - 400

Returned if neither a unit id or a unit external reference is passed in the request body

No unit specified for the lease

{
   "error": {
    "type": "no_unit",
    "message": "No unit id or unit external reference provided."
  }
}

Status Code - 400

Returned if a unit with the specified unit id or unit external reference could not be retrieved

Unit to use for lease not found

{
   "error": {
    "type": "unit_not_found",
    "message": "No unit with the provided unit id or unit external reference."
  }
}

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

curl --location --request POST 'https://api.travtus.com/leases/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
  "lease": {
    "identifier": "lease-1",
    "start_date": "2023-01-17",
    "end_date": "2023-12-17",
    "move_in_date": "2023-01-17",
    "unit_id": "unit-id-1",
    "unit_external_ref": "unit-external-ref-1",
    "is_furnished": false,
    "minimum_days_notice": 30,
    "deposit": 1400.0,
    "rent": 700.0
  },
  "tenants": [
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 1",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567891"
    }
  ]
}'

{
  "success": true,
  "lease": "lease-1"
}

Create/Update Leases And Tenants

Header

Body

Response

Errors

Introduction

Deployment Guide

Travtus API & Webhook

Miscellaneous

Glossary

Create/Update Leases And Tenants

Header

Body

Response

Errors

​Header

​Body

​Response

​Errors

Introduction

Deployment Guide

Travtus API & Webhook

Miscellaneous

Glossary

​Header

​Body

​Response

​Errors

Header

Body

Response

Errors

Header

Body

Response

Errors