Maintenance Issues
Update a maintenance issue
POST
/
v1
/
maintenance
/
issues
/
{id}
Update a maintenance issue
curl --request POST \
--url https://api.yorlet.com/v1/maintenance/issues/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"customer_presence_requested": true,
"description": "<string>",
"is_communal": true,
"issue_sub_category": "<string>",
"metadata": {},
"photos": [
"<string>"
],
"priority": 2,
"unit": "<string>",
"videos": [
"<string>"
],
"on_hold": {
"reason": "<string>"
}
}
'import requests
url = "https://api.yorlet.com/v1/maintenance/issues/{id}"
payload = {
"name": "<string>",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"customer_presence_requested": True,
"description": "<string>",
"is_communal": True,
"issue_sub_category": "<string>",
"metadata": {},
"photos": ["<string>"],
"priority": 2,
"unit": "<string>",
"videos": ["<string>"],
"on_hold": { "reason": "<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({
name: '<string>',
access_instructions: '<string>',
application: '<string>',
assignee: '<string>',
customer_presence_requested: true,
description: '<string>',
is_communal: true,
issue_sub_category: '<string>',
metadata: {},
photos: ['<string>'],
priority: 2,
unit: '<string>',
videos: ['<string>'],
on_hold: {reason: '<string>'}
})
};
fetch('https://api.yorlet.com/v1/maintenance/issues/{id}', 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/issues/{id}",
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([
'name' => '<string>',
'access_instructions' => '<string>',
'application' => '<string>',
'assignee' => '<string>',
'customer_presence_requested' => true,
'description' => '<string>',
'is_communal' => true,
'issue_sub_category' => '<string>',
'metadata' => [
],
'photos' => [
'<string>'
],
'priority' => 2,
'unit' => '<string>',
'videos' => [
'<string>'
],
'on_hold' => [
'reason' => '<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/issues/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\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/issues/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/maintenance/issues/{id}")
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 \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "maintenance.issue",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"availability": {
"days_available": [
3
],
"every_day": true,
"time_slots": {}
},
"customer_presence_requested": true,
"customer_request": true,
"description": "<string>",
"first_responded_at": 123,
"is_communal": true,
"issue_category": "air_conditioning",
"issue_sub_category": "<string>",
"name": "<string>",
"on_hold": {
"at": 123,
"reason": "<string>"
},
"photos": [
"<string>"
],
"priority": 2,
"resolved": true,
"resolved_at": 123,
"sla": {
"paused_seconds": 123,
"resolution_due_at": 123,
"response_due_at": 123,
"status": "at_risk"
},
"status": "in_progress",
"triage": {
"enabled": true,
"portal_completion_session": "<string>",
"resolved": true
},
"type": "customer_request",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"last_customer_message_at": null,
"maintenance_chat": true,
"metadata": {},
"unread_messages": false,
"videos": []
}Body
application/json
Response
200 - application/json
Returns the maintenance issue object if the update succeeded.
Was this page helpful?
Update a maintenance issue
curl --request POST \
--url https://api.yorlet.com/v1/maintenance/issues/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"customer_presence_requested": true,
"description": "<string>",
"is_communal": true,
"issue_sub_category": "<string>",
"metadata": {},
"photos": [
"<string>"
],
"priority": 2,
"unit": "<string>",
"videos": [
"<string>"
],
"on_hold": {
"reason": "<string>"
}
}
'import requests
url = "https://api.yorlet.com/v1/maintenance/issues/{id}"
payload = {
"name": "<string>",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"customer_presence_requested": True,
"description": "<string>",
"is_communal": True,
"issue_sub_category": "<string>",
"metadata": {},
"photos": ["<string>"],
"priority": 2,
"unit": "<string>",
"videos": ["<string>"],
"on_hold": { "reason": "<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({
name: '<string>',
access_instructions: '<string>',
application: '<string>',
assignee: '<string>',
customer_presence_requested: true,
description: '<string>',
is_communal: true,
issue_sub_category: '<string>',
metadata: {},
photos: ['<string>'],
priority: 2,
unit: '<string>',
videos: ['<string>'],
on_hold: {reason: '<string>'}
})
};
fetch('https://api.yorlet.com/v1/maintenance/issues/{id}', 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/issues/{id}",
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([
'name' => '<string>',
'access_instructions' => '<string>',
'application' => '<string>',
'assignee' => '<string>',
'customer_presence_requested' => true,
'description' => '<string>',
'is_communal' => true,
'issue_sub_category' => '<string>',
'metadata' => [
],
'photos' => [
'<string>'
],
'priority' => 2,
'unit' => '<string>',
'videos' => [
'<string>'
],
'on_hold' => [
'reason' => '<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/issues/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\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/issues/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/maintenance/issues/{id}")
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 \"name\": \"<string>\",\n \"access_instructions\": \"<string>\",\n \"application\": \"<string>\",\n \"assignee\": \"<string>\",\n \"customer_presence_requested\": true,\n \"description\": \"<string>\",\n \"is_communal\": true,\n \"issue_sub_category\": \"<string>\",\n \"metadata\": {},\n \"photos\": [\n \"<string>\"\n ],\n \"priority\": 2,\n \"unit\": \"<string>\",\n \"videos\": [\n \"<string>\"\n ],\n \"on_hold\": {\n \"reason\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "maintenance.issue",
"access_instructions": "<string>",
"application": "<string>",
"assignee": "<string>",
"availability": {
"days_available": [
3
],
"every_day": true,
"time_slots": {}
},
"customer_presence_requested": true,
"customer_request": true,
"description": "<string>",
"first_responded_at": 123,
"is_communal": true,
"issue_category": "air_conditioning",
"issue_sub_category": "<string>",
"name": "<string>",
"on_hold": {
"at": 123,
"reason": "<string>"
},
"photos": [
"<string>"
],
"priority": 2,
"resolved": true,
"resolved_at": 123,
"sla": {
"paused_seconds": 123,
"resolution_due_at": 123,
"response_due_at": 123,
"status": "at_risk"
},
"status": "in_progress",
"triage": {
"enabled": true,
"portal_completion_session": "<string>",
"resolved": true
},
"type": "customer_request",
"unit": "<string>",
"account": "<string>",
"deleted": false,
"last_customer_message_at": null,
"maintenance_chat": true,
"metadata": {},
"unread_messages": false,
"videos": []
}