Update One Address
curl --request PUT \
--url https://api.upwell.com/api/rest/addresses/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"canonicalAddressId": "<string>",
"city": "<string>",
"companyName": "<string>",
"contactId": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/addresses/{id}"
payload = {
"id": "<string>",
"input": {
"canonicalAddressId": "<string>",
"city": "<string>",
"companyName": "<string>",
"contactId": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
canonicalAddressId: '<string>',
city: '<string>',
companyName: '<string>',
contactId: '<string>',
customerId: '<string>',
locationCodeId: '<string>',
name: '<string>',
phoneNumber: '<string>',
stateOrProvince: '<string>',
streetLine1: '<string>',
streetLine2: '<string>',
streetLine3: '<string>',
zipOrPostalCode: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/addresses/{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.upwell.com/api/rest/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'input' => [
'canonicalAddressId' => '<string>',
'city' => '<string>',
'companyName' => '<string>',
'contactId' => '<string>',
'customerId' => '<string>',
'locationCodeId' => '<string>',
'name' => '<string>',
'phoneNumber' => '<string>',
'stateOrProvince' => '<string>',
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'streetLine3' => '<string>',
'zipOrPostalCode' => '<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.upwell.com/api/rest/addresses/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/addresses/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/addresses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"type": "ADDRESS_BOOK",
"updatedAt": "2023-11-07T05:31:56Z",
"zipOrPostalCode": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}{
"error": "Authentication hook unauthorized this request",
"path": "$",
"code": "access-denied"
}Addresses
Update One Address
Update an address by ID
PUT
/
api
/
rest
/
addresses
/
{id}
Update One Address
curl --request PUT \
--url https://api.upwell.com/api/rest/addresses/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"canonicalAddressId": "<string>",
"city": "<string>",
"companyName": "<string>",
"contactId": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/addresses/{id}"
payload = {
"id": "<string>",
"input": {
"canonicalAddressId": "<string>",
"city": "<string>",
"companyName": "<string>",
"contactId": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
canonicalAddressId: '<string>',
city: '<string>',
companyName: '<string>',
contactId: '<string>',
customerId: '<string>',
locationCodeId: '<string>',
name: '<string>',
phoneNumber: '<string>',
stateOrProvince: '<string>',
streetLine1: '<string>',
streetLine2: '<string>',
streetLine3: '<string>',
zipOrPostalCode: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/addresses/{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.upwell.com/api/rest/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'input' => [
'canonicalAddressId' => '<string>',
'city' => '<string>',
'companyName' => '<string>',
'contactId' => '<string>',
'customerId' => '<string>',
'locationCodeId' => '<string>',
'name' => '<string>',
'phoneNumber' => '<string>',
'stateOrProvince' => '<string>',
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'streetLine3' => '<string>',
'zipOrPostalCode' => '<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.upwell.com/api/rest/addresses/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/addresses/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/addresses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyName\": \"<string>\",\n \"contactId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"type": "ADDRESS_BOOK",
"updatedAt": "2023-11-07T05:31:56Z",
"zipOrPostalCode": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}{
"error": "Authentication hook unauthorized this request",
"path": "$",
"code": "access-denied"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
Path Parameters
"id" is required (enter it either in parameters or request body)
Body
application/json
Query parameters can also be provided in the request body as a JSON object
Response
Responses for PUT /api/rest/addresses/{id}
columns and relationships of "addresses"
Show child attributes
Show child attributes