cURL
curl --request PATCH \
--url https://api.example.com/api/v1/persons/{id} \
--header 'Content-Type: application/json' \
--data '
{
"addresses": [
{
"street": "<string>",
"houseNumber": "<string>",
"additionalAddressInfo": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateCode": "<string>",
"country": "<string>"
}
],
"bankDetails": {
"iban": "<string>",
"bic": "<string>",
"payee": "<string>"
}
}
'import requests
url = "https://api.example.com/api/v1/persons/{id}"
payload = {
"addresses": [
{
"street": "<string>",
"houseNumber": "<string>",
"additionalAddressInfo": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateCode": "<string>",
"country": "<string>"
}
],
"bankDetails": {
"iban": "<string>",
"bic": "<string>",
"payee": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
addresses: [
{
street: '<string>',
houseNumber: '<string>',
additionalAddressInfo: '<string>',
zipCode: '<string>',
city: '<string>',
stateCode: '<string>',
country: '<string>'
}
],
bankDetails: {iban: '<string>', bic: '<string>', payee: '<string>'}
})
};
fetch('https://api.example.com/api/v1/persons/{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.example.com/api/v1/persons/{id}",
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([
'addresses' => [
[
'street' => '<string>',
'houseNumber' => '<string>',
'additionalAddressInfo' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateCode' => '<string>',
'country' => '<string>'
]
],
'bankDetails' => [
'iban' => '<string>',
'bic' => '<string>',
'payee' => '<string>'
]
]),
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/api/v1/persons/{id}"
payload := strings.NewReader("{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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/api/v1/persons/{id}")
.header("Content-Type", "application/json")
.body("{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodyEmployees & Organisation
Person By ID
PATCH
/
api
/
v1
/
persons
/
{id}
cURL
curl --request PATCH \
--url https://api.example.com/api/v1/persons/{id} \
--header 'Content-Type: application/json' \
--data '
{
"addresses": [
{
"street": "<string>",
"houseNumber": "<string>",
"additionalAddressInfo": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateCode": "<string>",
"country": "<string>"
}
],
"bankDetails": {
"iban": "<string>",
"bic": "<string>",
"payee": "<string>"
}
}
'import requests
url = "https://api.example.com/api/v1/persons/{id}"
payload = {
"addresses": [
{
"street": "<string>",
"houseNumber": "<string>",
"additionalAddressInfo": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateCode": "<string>",
"country": "<string>"
}
],
"bankDetails": {
"iban": "<string>",
"bic": "<string>",
"payee": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
addresses: [
{
street: '<string>',
houseNumber: '<string>',
additionalAddressInfo: '<string>',
zipCode: '<string>',
city: '<string>',
stateCode: '<string>',
country: '<string>'
}
],
bankDetails: {iban: '<string>', bic: '<string>', payee: '<string>'}
})
};
fetch('https://api.example.com/api/v1/persons/{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.example.com/api/v1/persons/{id}",
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([
'addresses' => [
[
'street' => '<string>',
'houseNumber' => '<string>',
'additionalAddressInfo' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateCode' => '<string>',
'country' => '<string>'
]
],
'bankDetails' => [
'iban' => '<string>',
'bic' => '<string>',
'payee' => '<string>'
]
]),
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/api/v1/persons/{id}"
payload := strings.NewReader("{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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/api/v1/persons/{id}")
.header("Content-Type", "application/json")
.body("{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"addresses\": [\n {\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"additionalAddressInfo\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateCode\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"payee\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodyWhile the endpoint itself supports the patch mechanism and individual fields can be transferred, this does not apply to the contents of those fields. For example, if only part of an address is transferred, it is stored exactly as it is, and any additional information is discarded.
Path Parameters
Body
application/json
Response
200
OK
Was this page helpful?
⌘I