Tenancies
Send compliance documents
Emails the unit’s current compliance documents (EPC, electric safety, gas safety) to the tenancy’s customers.
POST
/
v1
/
tenancies
/
{id}
/
send_compliance
Send compliance documents
curl --request POST \
--url https://api.yorlet.com/v1/tenancies/{id}/send_compliance \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"override_subject": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/tenancies/{id}/send_compliance"
payload = { "override_subject": "<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({override_subject: '<string>'})
};
fetch('https://api.yorlet.com/v1/tenancies/{id}/send_compliance', 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/tenancies/{id}/send_compliance",
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([
'override_subject' => '<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/tenancies/{id}/send_compliance"
payload := strings.NewReader("{\n \"override_subject\": \"<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/tenancies/{id}/send_compliance")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"override_subject\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/tenancies/{id}/send_compliance")
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 \"override_subject\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "tenancy",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"cancel_at": 123,
"canceled_at": 123,
"customers": [
{
"id": "<string>",
"email": "<string>",
"name": "<string>"
}
],
"date_end": 123,
"date_start": 123,
"has_owner": true,
"status": "active",
"timezone": "<string>",
"type": "active_tenancy",
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"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>"
},
"checkout_session": "<string>",
"checkout_session_required": true,
"checkout_session_status": "pending",
"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>"
}
}
]
},
"assignee": "<string>",
"cancel_reason": "<string>",
"cancel_reason_description": "<string>",
"contract_address": "<string>",
"currency": "gbp",
"customer_emails": [
"<string>"
],
"deposit": {
"deposit_total": 123,
"deposit_per_applicant": 123
},
"end_behavior": "roll",
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"renewal_intent": "<string>",
"review": {
"assignee": "<string>",
"create_renewal_intent": true,
"due_at": 123,
"notification_channels": [
"dashboard"
]
},
"subscription_data": {
"billing_anchor": 123,
"collection_method": "charge_automatically",
"interval": "month",
"interval_count": 123,
"items": [
"<unknown>"
],
"phases": [
"<unknown>"
]
}
}Body
application/json
Response
200 - application/json
Returns the tenancy.
Was this page helpful?
Send compliance documents
curl --request POST \
--url https://api.yorlet.com/v1/tenancies/{id}/send_compliance \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"override_subject": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/tenancies/{id}/send_compliance"
payload = { "override_subject": "<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({override_subject: '<string>'})
};
fetch('https://api.yorlet.com/v1/tenancies/{id}/send_compliance', 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/tenancies/{id}/send_compliance",
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([
'override_subject' => '<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/tenancies/{id}/send_compliance"
payload := strings.NewReader("{\n \"override_subject\": \"<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/tenancies/{id}/send_compliance")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"override_subject\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/tenancies/{id}/send_compliance")
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 \"override_subject\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "tenancy",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"cancel_at": 123,
"canceled_at": 123,
"customers": [
{
"id": "<string>",
"email": "<string>",
"name": "<string>"
}
],
"date_end": 123,
"date_start": 123,
"has_owner": true,
"status": "active",
"timezone": "<string>",
"type": "active_tenancy",
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"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>"
},
"checkout_session": "<string>",
"checkout_session_required": true,
"checkout_session_status": "pending",
"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>"
}
}
]
},
"assignee": "<string>",
"cancel_reason": "<string>",
"cancel_reason_description": "<string>",
"contract_address": "<string>",
"currency": "gbp",
"customer_emails": [
"<string>"
],
"deposit": {
"deposit_total": 123,
"deposit_per_applicant": 123
},
"end_behavior": "roll",
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"renewal_intent": "<string>",
"review": {
"assignee": "<string>",
"create_renewal_intent": true,
"due_at": 123,
"notification_channels": [
"dashboard"
]
},
"subscription_data": {
"billing_anchor": 123,
"collection_method": "charge_automatically",
"interval": "month",
"interval_count": 123,
"items": [
"<unknown>"
],
"phases": [
"<unknown>"
]
}
}