Residents
Update a resident
Update a resident
POST
/
v1
/
loyalty
/
residents
/
{id}
Update a resident
curl --request POST \
--url https://api.yorlet.com/v1/loyalty/residents/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"building": "<string>",
"name": "<string>",
"tier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/loyalty/residents/{id}"
payload = {
"building": "<string>",
"name": "<string>",
"tier": "<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({building: '<string>', name: '<string>', tier: '<string>'})
};
fetch('https://api.yorlet.com/v1/loyalty/residents/{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/loyalty/residents/{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([
'building' => '<string>',
'name' => '<string>',
'tier' => '<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/loyalty/residents/{id}"
payload := strings.NewReader("{\n \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<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/loyalty/residents/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/loyalty/residents/{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 \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "resident",
"building": "<string>",
"consumer_link": "none",
"email": "<string>",
"name": "<string>",
"source": "manual",
"tier": "<string>",
"status": "active",
"account": "<string>",
"deleted": false
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Body
application/json
The ID of the building to associate the resident with.
Behaviour to apply when transitioning the resident to inactive status.
Show child attributes
Show child attributes
The resident's full name.
The ID of the loyalty tier to assign the resident to.
Pattern:
^[a-zA-Z0-9_]+$The status of the resident's membership.
Available options:
active, inactive Response
200 - application/json
Returns the updated resident.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
resident The building the resident is associated with.
Whether the resident is linked to a OneMove account. pending means the OneMove user has been asked to confirm they live at the building, rejected means they declined, and none means no OneMove account matches the resident.
Available options:
none, pending, linked, rejected The resident's email address.
The resident's full name.
How the resident was added. tenancy residents come from an active tenancy and are linked automatically, manual residents must be confirmed by the OneMove user.
Available options:
manual, tenancy The loyalty tier the resident is assigned to.
The status of the resident's membership.
Available options:
active, inactive The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?
Update a resident
curl --request POST \
--url https://api.yorlet.com/v1/loyalty/residents/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"building": "<string>",
"name": "<string>",
"tier": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/loyalty/residents/{id}"
payload = {
"building": "<string>",
"name": "<string>",
"tier": "<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({building: '<string>', name: '<string>', tier: '<string>'})
};
fetch('https://api.yorlet.com/v1/loyalty/residents/{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/loyalty/residents/{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([
'building' => '<string>',
'name' => '<string>',
'tier' => '<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/loyalty/residents/{id}"
payload := strings.NewReader("{\n \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<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/loyalty/residents/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/loyalty/residents/{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 \"building\": \"<string>\",\n \"name\": \"<string>\",\n \"tier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "resident",
"building": "<string>",
"consumer_link": "none",
"email": "<string>",
"name": "<string>",
"source": "manual",
"tier": "<string>",
"status": "active",
"account": "<string>",
"deleted": false
}