Change a person's profile
curl --request PATCH \
--url https://api.example.com/v1/settings/people/{personId} \
--header 'Content-Type: application/json' \
--cookie __Secure-better-auth.session_token= \
--data '
{
"supersedes": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"kinship": "<string>",
"birthDate": "<string>",
"caregiverDays": [
{
"subjectId": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/settings/people/{personId}"
payload = {
"supersedes": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"kinship": "<string>",
"birthDate": "<string>",
"caregiverDays": [{ "subjectId": "<string>" }]
}
headers = {
"cookie": "__Secure-better-auth.session_token=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
cookie: '__Secure-better-auth.session_token=',
'Content-Type': 'application/json'
},
body: JSON.stringify({
supersedes: '<string>',
operationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
at: '2023-11-07T05:31:56Z',
kinship: '<string>',
birthDate: '<string>',
caregiverDays: [{subjectId: '<string>'}]
})
};
fetch('https://api.example.com/v1/settings/people/{personId}', 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.example.com/v1/settings/people/{personId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'supersedes' => '<string>',
'operationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'at' => '2023-11-07T05:31:56Z',
'kinship' => '<string>',
'birthDate' => '<string>',
'caregiverDays' => [
[
'subjectId' => '<string>'
]
]
]),
CURLOPT_COOKIE => "__Secure-better-auth.session_token=",
CURLOPT_HTTPHEADER => [
"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.example.com/v1/settings/people/{personId}"
payload := strings.NewReader("{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Secure-better-auth.session_token=")
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.patch("https://api.example.com/v1/settings/people/{personId}")
.header("cookie", "__Secure-better-auth.session_token=")
.header("Content-Type", "application/json")
.body("{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/settings/people/{personId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Secure-better-auth.session_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"current": {
"id": "<string>",
"personId": "<string>",
"kinship": "<string>",
"birthDate": "<string>",
"ageYears": 123,
"caregiverDays": [
{
"weekday": "MO",
"duty": "take",
"subjectId": "<string>"
}
],
"source": "onboarding",
"confidence": "<string>",
"appliedAt": "2023-11-07T05:31:56Z",
"supersededBy": "<string>"
},
"superseded": {
"id": "<string>",
"personId": "<string>",
"kinship": "<string>",
"birthDate": "<string>",
"ageYears": 123,
"caregiverDays": [
{
"weekday": "MO",
"duty": "take",
"subjectId": "<string>"
}
],
"source": "onboarding",
"confidence": "<string>",
"appliedAt": "2023-11-07T05:31:56Z",
"supersededBy": "<string>"
}
}{
"code": "<string>",
"details": {}
}{
"code": "<string>",
"details": {}
}{
"code": "<string>",
"details": {}
}{
"code": "request.timeout",
"correlationId": "<string>"
}{
"code": "request.timeout",
"correlationId": "<string>"
}People
Change a person's profile
Writes a new profile (kinship, birth date, fixed roles) that supersedes the current one, never edits it: supersedes is the id of the current profile, and a stale one is a conflict. A field left out keeps its value, null clears it, and caregiverDays is sent whole. operationId makes a retry safe.
PATCH
/
v1
/
settings
/
people
/
{personId}
Change a person's profile
curl --request PATCH \
--url https://api.example.com/v1/settings/people/{personId} \
--header 'Content-Type: application/json' \
--cookie __Secure-better-auth.session_token= \
--data '
{
"supersedes": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"kinship": "<string>",
"birthDate": "<string>",
"caregiverDays": [
{
"subjectId": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/settings/people/{personId}"
payload = {
"supersedes": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"kinship": "<string>",
"birthDate": "<string>",
"caregiverDays": [{ "subjectId": "<string>" }]
}
headers = {
"cookie": "__Secure-better-auth.session_token=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
cookie: '__Secure-better-auth.session_token=',
'Content-Type': 'application/json'
},
body: JSON.stringify({
supersedes: '<string>',
operationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
at: '2023-11-07T05:31:56Z',
kinship: '<string>',
birthDate: '<string>',
caregiverDays: [{subjectId: '<string>'}]
})
};
fetch('https://api.example.com/v1/settings/people/{personId}', 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.example.com/v1/settings/people/{personId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'supersedes' => '<string>',
'operationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'at' => '2023-11-07T05:31:56Z',
'kinship' => '<string>',
'birthDate' => '<string>',
'caregiverDays' => [
[
'subjectId' => '<string>'
]
]
]),
CURLOPT_COOKIE => "__Secure-better-auth.session_token=",
CURLOPT_HTTPHEADER => [
"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.example.com/v1/settings/people/{personId}"
payload := strings.NewReader("{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Secure-better-auth.session_token=")
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.patch("https://api.example.com/v1/settings/people/{personId}")
.header("cookie", "__Secure-better-auth.session_token=")
.header("Content-Type", "application/json")
.body("{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/settings/people/{personId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Secure-better-auth.session_token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"supersedes\": \"<string>\",\n \"operationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"at\": \"2023-11-07T05:31:56Z\",\n \"kinship\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"caregiverDays\": [\n {\n \"subjectId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"current": {
"id": "<string>",
"personId": "<string>",
"kinship": "<string>",
"birthDate": "<string>",
"ageYears": 123,
"caregiverDays": [
{
"weekday": "MO",
"duty": "take",
"subjectId": "<string>"
}
],
"source": "onboarding",
"confidence": "<string>",
"appliedAt": "2023-11-07T05:31:56Z",
"supersededBy": "<string>"
},
"superseded": {
"id": "<string>",
"personId": "<string>",
"kinship": "<string>",
"birthDate": "<string>",
"ageYears": 123,
"caregiverDays": [
{
"weekday": "MO",
"duty": "take",
"subjectId": "<string>"
}
],
"source": "onboarding",
"confidence": "<string>",
"appliedAt": "2023-11-07T05:31:56Z",
"supersededBy": "<string>"
}
}{
"code": "<string>",
"details": {}
}{
"code": "<string>",
"details": {}
}{
"code": "<string>",
"details": {}
}{
"code": "request.timeout",
"correlationId": "<string>"
}{
"code": "request.timeout",
"correlationId": "<string>"
}Authorizations
The session cookie set when you sign in to the web app.
Path Parameters
Maximum string length:
64Body
application/json
Maximum string length:
64Maximum string length:
160Maximum string length:
10Pattern:
^\d{4}-\d{2}-\d{2}$Maximum array length:
14Show child attributes
Show child attributes