Maintenance Jobs
Create a maintenance job
POST
/
v1
/
maintenance
/
jobs
Create a maintenance job
curl --request POST \
--url https://api.yorlet.com/v1/maintenance/jobs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"issue": "<string>",
"name": "<string>",
"assignee": "<string>",
"cost": {
"amount": 1,
"currency": "gbp"
},
"description": "<string>",
"in_house": true,
"supplier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/maintenance/jobs"
payload = {
"issue": "<string>",
"name": "<string>",
"assignee": "<string>",
"cost": {
"amount": 1,
"currency": "gbp"
},
"description": "<string>",
"in_house": True,
"supplier": "<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({
issue: '<string>',
name: '<string>',
assignee: '<string>',
cost: {amount: 1, currency: 'gbp'},
description: '<string>',
in_house: true,
supplier: '<string>'
})
};
fetch('https://api.yorlet.com/v1/maintenance/jobs', 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/maintenance/jobs",
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([
'issue' => '<string>',
'name' => '<string>',
'assignee' => '<string>',
'cost' => [
'amount' => 1,
'currency' => 'gbp'
],
'description' => '<string>',
'in_house' => true,
'supplier' => '<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/maintenance/jobs"
payload := strings.NewReader("{\n \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<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/maintenance/jobs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/maintenance/jobs")
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 \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "maintenance.job",
"approved_quote": "<string>",
"assignee": "<string>",
"billed_to": "landlord",
"billing": {
"account_collections": [
"<string>"
],
"tenant_invoice": "<string>",
"tenant_deposit_charge": "<string>"
},
"canceled_at": 123,
"cancellation_reason": "<string>",
"completed_at": 123,
"completion_notes": "<string>",
"cost": {
"amount": 123,
"currency": "gbp"
},
"description": "<string>",
"in_house": true,
"invoices": [
"<string>"
],
"issue": "<string>",
"landlord_approval": {
"method": "link",
"note": "<string>",
"owner": "<string>",
"recorded_at": 123,
"recorded_by": "<string>",
"requested_at": 123,
"status": "not_required",
"threshold_amount": 123,
"amount": 123
},
"name": "<string>",
"scheduled_end_at": 123,
"scheduled_start_at": 123,
"started_at": 123,
"status": "draft",
"supplier": "<string>",
"unit": "<string>",
"account": "<string>",
"deleted": false
}Body
application/json
Response
200 - application/json
Returns the maintenance job object if the request succeeded.
Was this page helpful?
Create a maintenance job
curl --request POST \
--url https://api.yorlet.com/v1/maintenance/jobs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"issue": "<string>",
"name": "<string>",
"assignee": "<string>",
"cost": {
"amount": 1,
"currency": "gbp"
},
"description": "<string>",
"in_house": true,
"supplier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/maintenance/jobs"
payload = {
"issue": "<string>",
"name": "<string>",
"assignee": "<string>",
"cost": {
"amount": 1,
"currency": "gbp"
},
"description": "<string>",
"in_house": True,
"supplier": "<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({
issue: '<string>',
name: '<string>',
assignee: '<string>',
cost: {amount: 1, currency: 'gbp'},
description: '<string>',
in_house: true,
supplier: '<string>'
})
};
fetch('https://api.yorlet.com/v1/maintenance/jobs', 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/maintenance/jobs",
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([
'issue' => '<string>',
'name' => '<string>',
'assignee' => '<string>',
'cost' => [
'amount' => 1,
'currency' => 'gbp'
],
'description' => '<string>',
'in_house' => true,
'supplier' => '<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/maintenance/jobs"
payload := strings.NewReader("{\n \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<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/maintenance/jobs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/maintenance/jobs")
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 \"issue\": \"<string>\",\n \"name\": \"<string>\",\n \"assignee\": \"<string>\",\n \"cost\": {\n \"amount\": 1,\n \"currency\": \"gbp\"\n },\n \"description\": \"<string>\",\n \"in_house\": true,\n \"supplier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "maintenance.job",
"approved_quote": "<string>",
"assignee": "<string>",
"billed_to": "landlord",
"billing": {
"account_collections": [
"<string>"
],
"tenant_invoice": "<string>",
"tenant_deposit_charge": "<string>"
},
"canceled_at": 123,
"cancellation_reason": "<string>",
"completed_at": 123,
"completion_notes": "<string>",
"cost": {
"amount": 123,
"currency": "gbp"
},
"description": "<string>",
"in_house": true,
"invoices": [
"<string>"
],
"issue": "<string>",
"landlord_approval": {
"method": "link",
"note": "<string>",
"owner": "<string>",
"recorded_at": 123,
"recorded_by": "<string>",
"requested_at": 123,
"status": "not_required",
"threshold_amount": 123,
"amount": 123
},
"name": "<string>",
"scheduled_end_at": 123,
"scheduled_start_at": 123,
"started_at": 123,
"status": "draft",
"supplier": "<string>",
"unit": "<string>",
"account": "<string>",
"deleted": false
}