curl --request PATCH \
--url https://api.contracting.kukkingu.software/api/v1/addresses/{addressId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant-id: <tenant-id>' \
--data '
{
"name": "Acme Corporation",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"order": 13,
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh"
}
'import requests
url = "https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}"
payload = {
"name": "Acme Corporation",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"order": 13,
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh"
}
headers = {
"tenant-id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'tenant-id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Corporation',
registrationNumber: 'ACME-123',
vatNumber: 'VAT-987654',
address1: '123 Main St',
address2: 'Suite 400',
region: 'California',
country: 'United States',
city: 'San Francisco',
zip: '94103',
order: 13,
clientId: 'clnt_z2b3mo8qa5kzptgsu26q2wmh'
})
};
fetch('https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}', 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.contracting.kukkingu.software/api/v1/addresses/{addressId}",
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([
'name' => 'Acme Corporation',
'registrationNumber' => 'ACME-123',
'vatNumber' => 'VAT-987654',
'address1' => '123 Main St',
'address2' => 'Suite 400',
'region' => 'California',
'country' => 'United States',
'city' => 'San Francisco',
'zip' => '94103',
'order' => 13,
'clientId' => 'clnt_z2b3mo8qa5kzptgsu26q2wmh'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant-id: <tenant-id>"
],
]);
$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.contracting.kukkingu.software/api/v1/addresses/{addressId}"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("tenant-id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <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.contracting.kukkingu.software/api/v1/addresses/{addressId}")
.header("tenant-id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"createdAt": "2023-10-05T14:48:00.000Z",
"updatedAt": "2023-10-05T14:48:00.000Z",
"client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
}{
"error": "ValidationError",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"constraint": "<string>"
}
]
}{
"error": "Unauthorized",
"message": "Unauthorized"
}{
"error": "Forbidden",
"message": "Forbidden"
}{
"error": "NotFound",
"message": "Not Found"
}Partially update address
Partially updates an existing address by its ID.
curl --request PATCH \
--url https://api.contracting.kukkingu.software/api/v1/addresses/{addressId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant-id: <tenant-id>' \
--data '
{
"name": "Acme Corporation",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"order": 13,
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh"
}
'import requests
url = "https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}"
payload = {
"name": "Acme Corporation",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"order": 13,
"clientId": "clnt_z2b3mo8qa5kzptgsu26q2wmh"
}
headers = {
"tenant-id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'tenant-id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Corporation',
registrationNumber: 'ACME-123',
vatNumber: 'VAT-987654',
address1: '123 Main St',
address2: 'Suite 400',
region: 'California',
country: 'United States',
city: 'San Francisco',
zip: '94103',
order: 13,
clientId: 'clnt_z2b3mo8qa5kzptgsu26q2wmh'
})
};
fetch('https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}', 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.contracting.kukkingu.software/api/v1/addresses/{addressId}",
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([
'name' => 'Acme Corporation',
'registrationNumber' => 'ACME-123',
'vatNumber' => 'VAT-987654',
'address1' => '123 Main St',
'address2' => 'Suite 400',
'region' => 'California',
'country' => 'United States',
'city' => 'San Francisco',
'zip' => '94103',
'order' => 13,
'clientId' => 'clnt_z2b3mo8qa5kzptgsu26q2wmh'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant-id: <tenant-id>"
],
]);
$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.contracting.kukkingu.software/api/v1/addresses/{addressId}"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("tenant-id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <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.contracting.kukkingu.software/api/v1/addresses/{addressId}")
.header("tenant-id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contracting.kukkingu.software/api/v1/addresses/{addressId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"registrationNumber\": \"ACME-123\",\n \"vatNumber\": \"VAT-987654\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 400\",\n \"region\": \"California\",\n \"country\": \"United States\",\n \"city\": \"San Francisco\",\n \"zip\": \"94103\",\n \"order\": 13,\n \"clientId\": \"clnt_z2b3mo8qa5kzptgsu26q2wmh\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
"name": "Acme Corporation",
"address1": "123 Main St",
"address2": "Suite 400",
"region": "California",
"country": "United States",
"city": "San Francisco",
"zip": "94103",
"createdAt": "2023-10-05T14:48:00.000Z",
"updatedAt": "2023-10-05T14:48:00.000Z",
"client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
"registrationNumber": "ACME-123",
"vatNumber": "VAT-987654",
"order": 13
}
}{
"error": "ValidationError",
"message": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"constraint": "<string>"
}
]
}{
"error": "Unauthorized",
"message": "Unauthorized"
}{
"error": "Forbidden",
"message": "Forbidden"
}{
"error": "NotFound",
"message": "Not Found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Specifies the tenant context for the request. All endpoints operate within this tenant scope.
"tnt_pfh0haxfpzowht3oi213cqos"
Path Parameters
The ID of the address.
1"adr_ekq4ymw1nyyd4b6k6f5tg3t6"
Body
Request body used to partially update an existing address resource.
Request body used to partially update an existing address resource.
Display label for the address, typically the legal entity name.
1 - 200"Acme Corporation"
Company registration number associated with the address.
100"ACME-123"
VAT number for the entity at this address.
100"VAT-987654"
Primary address line.
1 - 200"123 Main St"
Secondary address line.
200"Suite 400"
State or region for the address.
100"California"
Country for the address.
1 - 100"United States"
City for the address.
1 - 100"San Francisco"
Postal or ZIP code.
1 - 20"94103"
Order of the resource for sorting purposes.
0 <= x <= 900719925474099113
Unique identifier of the client.
1"clnt_z2b3mo8qa5kzptgsu26q2wmh"
Response
Default Response
Standard success response payload wrapped in a data property.
Address resource returned by the API.
Show child attributes
Show child attributes