Apply for a unit

POST

units

{id}

apply

Apply for a unit

curl --request POST \
  --url https://api.yorlet.com/v1/units/{id}/apply \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicant": {
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>"
  },
  "start_date": 123,
  "enquiry": "<string>"
}
'

import requests

url = "https://api.yorlet.com/v1/units/{id}/apply"

payload = {
    "applicant": {
        "email": "<string>",
        "name": "<string>",
        "phone": "<string>"
    },
    "start_date": 123,
    "enquiry": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    applicant: {email: '<string>', name: '<string>', phone: '<string>'},
    start_date: 123,
    enquiry: '<string>'
  })
};

fetch('https://api.yorlet.com/v1/units/{id}/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/units/{id}/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicant' => [
        'email' => '<string>',
        'name' => '<string>',
        'phone' => '<string>'
    ],
    'start_date' => 123,
    'enquiry' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/units/{id}/apply"

	payload := strings.NewReader("{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/units/{id}/apply")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/units/{id}/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created": 123,
  "object": "application",
  "advance_rent_amount": 123,
  "application_configuration": "<string>",
  "application_mode": "classic",
  "assignee": "<string>",
  "building": "<string>",
  "building_snapshot": {
    "name": "<string>",
    "single_unit": true
  },
  "completed_at": 123,
  "contract": "<string>",
  "contract_address": "<string>",
  "contract_options": {
    "automatic_counter_signature": true,
    "legal_entity": "<string>",
    "owner_signature_required": true,
    "send_applicant_email": true,
    "send_owner_completion_email": true
  },
  "contract_template": "<string>",
  "current_step": {
    "id": "<string>",
    "next_step": "<string>",
    "type": "advance_rent"
  },
  "currency": "gbp",
  "customers": [
    {
      "id": "<string>",
      "email": "<string>",
      "name": "<string>"
    }
  ],
  "deal_assignee": "<string>",
  "deposit_amount": 123,
  "has_owner": true,
  "holding_fee_amount": 123,
  "restrict_credits_to_application": true,
  "end_behavior": "roll",
  "end_date": 123,
  "from_application": {
    "action": "revision",
    "application": "<string>"
  },
  "move_in_date": 123,
  "move_out_date": 123,
  "open": true,
  "owner_options": {
    "apply_unit_fees": true,
    "custom_fee_amount": 50000000
  },
  "partial_payment": {
    "amount": 49999950,
    "description": "<string>"
  },
  "rent_term": "<string>",
  "start_date": 123,
  "status": "<string>",
  "subscription_data": {
    "collection_method": "charge_automatically",
    "interval": "month",
    "add_invoice_items": [
      {
        "amount": 123,
        "currency": "<string>",
        "description": "<string>",
        "tax_percent": 50,
        "transfer_behavior": "automatic",
        "type": "charge",
        "metadata": {},
        "price": "<string>",
        "tax_rate": "<string>",
        "transfer_destination": "<string>",
        "unit": "<string>"
      }
    ],
    "billing_anchor": 123,
    "billing_anchor_config": {
      "day_of_month": 16
    },
    "coupon": "<string>",
    "custom_fields": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "days_before_collection": 3,
    "days_until_due": 1,
    "end_date": 123,
    "end_date_config": {
      "day": 16,
      "month": 6,
      "year": 123
    },
    "first_invoice_creation": "immediately",
    "interval_count": 123,
    "items": [
      {
        "price_data": {
          "amount": 123,
          "currency": "gbp",
          "tax_percent": 123
        },
        "type": "charge",
        "description": "<string>",
        "metadata": {},
        "price": "<string>",
        "proration_behavior": "create_prorations",
        "schedule": [
          {
            "amount": 123,
            "effective_at": 123,
            "effective_at_config": {
              "day": 16,
              "month": 6,
              "year": 123
            }
          }
        ],
        "tax_rate": "<string>",
        "transfer_behavior": "automatic",
        "transfer_destination": "<string>",
        "unit": "<string>"
      }
    ],
    "phases": [
      {
        "start_date": 123,
        "items": [
          {
            "price_data": {
              "amount": 123,
              "currency": "gbp",
              "tax_percent": 123
            },
            "type": "charge",
            "description": "<string>",
            "metadata": {},
            "price": "<string>",
            "proration_behavior": "create_prorations",
            "schedule": [
              {
                "amount": 123,
                "effective_at": 123,
                "effective_at_config": {
                  "day": 16,
                  "month": 6,
                  "year": 123
                }
              }
            ],
            "tax_rate": "<string>",
            "transfer_behavior": "automatic",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ]
      }
    ],
    "start_date": 123,
    "start_date_config": {
      "day": 16,
      "month": 6,
      "year": 123
    }
  },
  "type": "active_tenancy",
  "unit": "<string>",
  "unit_snapshot": {
    "name": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "advance_rent_count": 123,
  "advance_rent_total": 123,
  "applicants": {
    "count": 1,
    "has_more": false,
    "object": "list",
    "data": [
      {
        "id": "<string>",
        "created": 123,
        "object": "application.applicant",
        "application": "<string>",
        "advance_rent": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "currency": "gbp",
        "customer": "<string>",
        "deposit": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "guarantor": "<string>",
        "guarantor_contract": "<string>",
        "holding_fee": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "lead_tenant": true,
        "permitted_occupier": true,
        "requirements": {
          "guarantor": true
        },
        "share_of_rent": 123,
        "status": "<string>",
        "tos_acceptance": {
          "date": 123,
          "ip": "<string>"
        },
        "verification_session": "<string>",
        "verification_session_required": true,
        "account": "<string>",
        "deleted": false,
        "pets": [
          {
            "age": 123,
            "name": "<string>",
            "type": "dog"
          }
        ],
        "pre_qualification": {
          "affordability": {
            "company_name": "<string>",
            "gross_annual_salary": 123,
            "role": "<string>"
          },
          "nationality": "<string>"
        }
      }
    ]
  },
  "customer_emails": [
    "<string>"
  ],
  "deposit_count": 123,
  "deposit_total": 123,
  "holding_fee_count": 123,
  "holding_fee_total": 123,
  "metadata": {},
  "overrides": {
    "rent_increase": {
      "tenancy_start_at": 123,
      "first_increase_at": 123
    }
  },
  "steps": [
    {
      "id": "<string>",
      "status": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

string

required

The id identifier.

Body

application/json

applicant

object

required

The lead applicant the application is created for.

Show child attributes

start_date

number

required

The date the applicant wants the tenancy to start. Cannot be before the date the unit is available from.

enquiry

string | null

The identifier of the lead enquiry the application is being started from. The enquiry is moved to the application stage.

Pattern: ^[a-zA-Z0-9_]+$

Response

200 - application/json

Returns the application object if the application was started.

string

required

Unique identifier for the object.

created

number

required

Time at which the object was created. Measured in seconds since the Unix epoch.

object

enum<string>

required

Available options:

application

advance_rent_amount

integer | null

required

The advance rent amount for the application.

application_configuration

required

The identifier of the application configuration.

application_mode

enum<string>

required

The mode of the application.

Available options:

classic,

configuration

assignee

string | null

required

The identifier of the assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$

building

required

The identifier of the building for the application.

building_snapshot

object

required

A snapshot of the building at the time of the application.

Show child attributes

completed_at

integer | null

required

The date and time the application was completed.

contract

required

The identifier of the contract for the application.

contract_address

string | null

required

The address of the contract for the application.

contract_options

object

required

The contract options for the application.

Show child attributes

contract_template

required

The identifier of the contract template for the application.

current_step

Advance rent · object

required

The current step of the application configuration.

Show child attributes

currency

enum<string>

required

The currency for the application.

Available options:

gbp,

usd,

eur,

sek

Example:

"gbp"

customers

object[]

required

The customers for the tenancy.

Show child attributes

deal_assignee

string | null

required

The identifier of the deal assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$

deposit_amount

integer | null

required

The deposit amount for the application.

has_owner

boolean

required

Whether the application has an owner.

holding_fee_amount

integer | null

required

The holding fee amount for the application.

restrict_credits_to_application

boolean

required

Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices, rather than the next invoice for the customer.

end_behavior

enum<string> | null

required

The end behavior for the application.

Available options:

roll,

complete,

null

end_date

integer | null

required

The end date of the application.

from_application

object | null

required

The from application for the application.

Show child attributes

move_in_date

integer | null

required

The expected move in date for the application.

move_out_date

integer | null

required

The expected move out date for the application.

open

boolean

required

Whether the application is open.

owner_options

object | null

required

The owner options for the application.

Show child attributes

partial_payment

object | null

required

The partial payment details for the application.

Show child attributes

rent_term

string | null

required

The rent term for the application.

start_date

integer | null

required

The start date of the application.

status

string

required

The status of the application.

subscription_data

object

required

The subscription data for the application.

Show child attributes

type

enum<string>

required

The type of the application.

Available options:

active_tenancy,

let_only,

renewal,

standard

unit

required

The identifier of the unit for the application.

unit_snapshot

object

required

A snapshot of the unit at the time of the application.

Show child attributes

account

string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted

boolean

default:false

Only returned if the object has been deleted.

advance_rent_count

integer

The number of advance rent payments collected for the application.

advance_rent_total

integer

The number of advance rent payments required for the application.

applicants

object

The applicants for the application.

Show child attributes

customer_emails

(string | null)[]

The customer emails for the tenancy.

deposit_count

integer

The number of deposit payments collected for the application.

deposit_total

integer

The number of deposit payments required for the application.

holding_fee_count

integer

The number of holding fee payments collected for the application.

holding_fee_total

integer

The number of holding fee payments required for the application.

metadata

object | null

The metadata for the application.

Show child attributes

overrides

object | null

Manual overrides carried forward at the tenancy level, applied when generating documents such as the Form 4A rent increase notice.

Show child attributes

steps

object[]

The steps of the application configuration.

Show child attributes

Apply for a unit

curl --request POST \
  --url https://api.yorlet.com/v1/units/{id}/apply \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicant": {
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>"
  },
  "start_date": 123,
  "enquiry": "<string>"
}
'

import requests

url = "https://api.yorlet.com/v1/units/{id}/apply"

payload = {
    "applicant": {
        "email": "<string>",
        "name": "<string>",
        "phone": "<string>"
    },
    "start_date": 123,
    "enquiry": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    applicant: {email: '<string>', name: '<string>', phone: '<string>'},
    start_date: 123,
    enquiry: '<string>'
  })
};

fetch('https://api.yorlet.com/v1/units/{id}/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/units/{id}/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicant' => [
        'email' => '<string>',
        'name' => '<string>',
        'phone' => '<string>'
    ],
    'start_date' => 123,
    'enquiry' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/units/{id}/apply"

	payload := strings.NewReader("{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/units/{id}/apply")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/units/{id}/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicant\": {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"start_date\": 123,\n  \"enquiry\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created": 123,
  "object": "application",
  "advance_rent_amount": 123,
  "application_configuration": "<string>",
  "application_mode": "classic",
  "assignee": "<string>",
  "building": "<string>",
  "building_snapshot": {
    "name": "<string>",
    "single_unit": true
  },
  "completed_at": 123,
  "contract": "<string>",
  "contract_address": "<string>",
  "contract_options": {
    "automatic_counter_signature": true,
    "legal_entity": "<string>",
    "owner_signature_required": true,
    "send_applicant_email": true,
    "send_owner_completion_email": true
  },
  "contract_template": "<string>",
  "current_step": {
    "id": "<string>",
    "next_step": "<string>",
    "type": "advance_rent"
  },
  "currency": "gbp",
  "customers": [
    {
      "id": "<string>",
      "email": "<string>",
      "name": "<string>"
    }
  ],
  "deal_assignee": "<string>",
  "deposit_amount": 123,
  "has_owner": true,
  "holding_fee_amount": 123,
  "restrict_credits_to_application": true,
  "end_behavior": "roll",
  "end_date": 123,
  "from_application": {
    "action": "revision",
    "application": "<string>"
  },
  "move_in_date": 123,
  "move_out_date": 123,
  "open": true,
  "owner_options": {
    "apply_unit_fees": true,
    "custom_fee_amount": 50000000
  },
  "partial_payment": {
    "amount": 49999950,
    "description": "<string>"
  },
  "rent_term": "<string>",
  "start_date": 123,
  "status": "<string>",
  "subscription_data": {
    "collection_method": "charge_automatically",
    "interval": "month",
    "add_invoice_items": [
      {
        "amount": 123,
        "currency": "<string>",
        "description": "<string>",
        "tax_percent": 50,
        "transfer_behavior": "automatic",
        "type": "charge",
        "metadata": {},
        "price": "<string>",
        "tax_rate": "<string>",
        "transfer_destination": "<string>",
        "unit": "<string>"
      }
    ],
    "billing_anchor": 123,
    "billing_anchor_config": {
      "day_of_month": 16
    },
    "coupon": "<string>",
    "custom_fields": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "days_before_collection": 3,
    "days_until_due": 1,
    "end_date": 123,
    "end_date_config": {
      "day": 16,
      "month": 6,
      "year": 123
    },
    "first_invoice_creation": "immediately",
    "interval_count": 123,
    "items": [
      {
        "price_data": {
          "amount": 123,
          "currency": "gbp",
          "tax_percent": 123
        },
        "type": "charge",
        "description": "<string>",
        "metadata": {},
        "price": "<string>",
        "proration_behavior": "create_prorations",
        "schedule": [
          {
            "amount": 123,
            "effective_at": 123,
            "effective_at_config": {
              "day": 16,
              "month": 6,
              "year": 123
            }
          }
        ],
        "tax_rate": "<string>",
        "transfer_behavior": "automatic",
        "transfer_destination": "<string>",
        "unit": "<string>"
      }
    ],
    "phases": [
      {
        "start_date": 123,
        "items": [
          {
            "price_data": {
              "amount": 123,
              "currency": "gbp",
              "tax_percent": 123
            },
            "type": "charge",
            "description": "<string>",
            "metadata": {},
            "price": "<string>",
            "proration_behavior": "create_prorations",
            "schedule": [
              {
                "amount": 123,
                "effective_at": 123,
                "effective_at_config": {
                  "day": 16,
                  "month": 6,
                  "year": 123
                }
              }
            ],
            "tax_rate": "<string>",
            "transfer_behavior": "automatic",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ]
      }
    ],
    "start_date": 123,
    "start_date_config": {
      "day": 16,
      "month": 6,
      "year": 123
    }
  },
  "type": "active_tenancy",
  "unit": "<string>",
  "unit_snapshot": {
    "name": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "advance_rent_count": 123,
  "advance_rent_total": 123,
  "applicants": {
    "count": 1,
    "has_more": false,
    "object": "list",
    "data": [
      {
        "id": "<string>",
        "created": 123,
        "object": "application.applicant",
        "application": "<string>",
        "advance_rent": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "currency": "gbp",
        "customer": "<string>",
        "deposit": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "guarantor": "<string>",
        "guarantor_contract": "<string>",
        "holding_fee": {
          "amount": 123,
          "paid": true,
          "paid_off_platform": true,
          "transaction": "<string>"
        },
        "lead_tenant": true,
        "permitted_occupier": true,
        "requirements": {
          "guarantor": true
        },
        "share_of_rent": 123,
        "status": "<string>",
        "tos_acceptance": {
          "date": 123,
          "ip": "<string>"
        },
        "verification_session": "<string>",
        "verification_session_required": true,
        "account": "<string>",
        "deleted": false,
        "pets": [
          {
            "age": 123,
            "name": "<string>",
            "type": "dog"
          }
        ],
        "pre_qualification": {
          "affordability": {
            "company_name": "<string>",
            "gross_annual_salary": 123,
            "role": "<string>"
          },
          "nationality": "<string>"
        }
      }
    ]
  },
  "customer_emails": [
    "<string>"
  ],
  "deposit_count": 123,
  "deposit_total": 123,
  "holding_fee_count": 123,
  "holding_fee_total": 123,
  "metadata": {},
  "overrides": {
    "rent_increase": {
      "tenancy_start_at": 123,
      "first_increase_at": 123
    }
  },
  "steps": [
    {
      "id": "<string>",
      "status": "<string>",
      "type": "<string>"
    }
  ]
}

Yorlet API

Billing

Checkout

Core

Guardrails

Leads

Leasing

Loyalty

Maintenance

Owners

Payments

Terminal

Test Helpers

Authorizations

Path Parameters

Body

Response