curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mailing_line_1": "<string>",
"mailing_line_2": "<string>",
"mailing_city": "<string>",
"mailing_state": "<string>",
"mailing_zip_code": "<string>",
"mailing_country": "<string>",
"mailing_phone": "<string>"
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address"
payload = {
"mailing_line_1": "<string>",
"mailing_line_2": "<string>",
"mailing_city": "<string>",
"mailing_state": "<string>",
"mailing_zip_code": "<string>",
"mailing_country": "<string>",
"mailing_phone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mailing_line_1: '<string>',
mailing_line_2: '<string>',
mailing_city: '<string>',
mailing_state: '<string>',
mailing_zip_code: '<string>',
mailing_country: '<string>',
mailing_phone: '<string>'
})
};
fetch('https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address', 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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address",
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([
'mailing_line_1' => '<string>',
'mailing_line_2' => '<string>',
'mailing_city' => '<string>',
'mailing_state' => '<string>',
'mailing_zip_code' => '<string>',
'mailing_country' => '<string>',
'mailing_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address"
payload := strings.NewReader("{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": {
"user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"name": "John Doe",
"email": "john.doe@example.com",
"is_active": true,
"created_at": "2025-06-10T18:10:42.000Z",
"mailing_line_1": "500 W 2nd St",
"mailing_line_2": "Suite 1900",
"mailing_city": "Austin",
"mailing_state": "TX",
"mailing_zip_code": "78701",
"mailing_country": "US",
"mailing_phone": "+15125550123"
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Set a User's Mailing Address
Set or replace a user’s mailing address.
This is the address printed on the shipper/FROM block of a mailed-document
(USPS/FedEx) shipping label. Once every field is present — including
mailing_phone, which FedEx requires — a document you mail for this user
prints their address as the sender instead of your platform’s default
collection address.
This is a full replace, not a merge: send every field you want to keep on
each call. A field you leave out is cleared. Send an all-null body (or {}) to
remove the address entirely, after which the label falls back to the default
collection address.
curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mailing_line_1": "<string>",
"mailing_line_2": "<string>",
"mailing_city": "<string>",
"mailing_state": "<string>",
"mailing_zip_code": "<string>",
"mailing_country": "<string>",
"mailing_phone": "<string>"
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address"
payload = {
"mailing_line_1": "<string>",
"mailing_line_2": "<string>",
"mailing_city": "<string>",
"mailing_state": "<string>",
"mailing_zip_code": "<string>",
"mailing_country": "<string>",
"mailing_phone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mailing_line_1: '<string>',
mailing_line_2: '<string>',
mailing_city: '<string>',
mailing_state: '<string>',
mailing_zip_code: '<string>',
mailing_country: '<string>',
mailing_phone: '<string>'
})
};
fetch('https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address', 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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address",
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([
'mailing_line_1' => '<string>',
'mailing_line_2' => '<string>',
'mailing_city' => '<string>',
'mailing_state' => '<string>',
'mailing_zip_code' => '<string>',
'mailing_country' => '<string>',
'mailing_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address"
payload := strings.NewReader("{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/users/{user_id}/mailing-address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mailing_line_1\": \"<string>\",\n \"mailing_line_2\": \"<string>\",\n \"mailing_city\": \"<string>\",\n \"mailing_state\": \"<string>\",\n \"mailing_zip_code\": \"<string>\",\n \"mailing_country\": \"<string>\",\n \"mailing_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": {
"user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"name": "John Doe",
"email": "john.doe@example.com",
"is_active": true,
"created_at": "2025-06-10T18:10:42.000Z",
"mailing_line_1": "500 W 2nd St",
"mailing_line_2": "Suite 1900",
"mailing_city": "Austin",
"mailing_state": "TX",
"mailing_zip_code": "78701",
"mailing_country": "US",
"mailing_phone": "+15125550123"
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique ID of the user whose mailing address you want to set.
"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"
Body
Set or replace a user's mailing address.
This is the address printed on the shipper/FROM block of a mailed-document
(USPS/FedEx) shipping label, used in place of your platform's default
collection address once every field here — including mailing_phone, which
FedEx requires — is present.
A full replace, not a merge: send every field you want kept on each call. Send an all-null body to clear the address (the label then falls back to the default collection address).
25525512012020ISO 3166-1 alpha-2 country code, e.g. US.
2Required for the address to be usable on a FedEx label — FedEx rejects a shipment with no shipper phone.
40Response
The user with its updated mailing address.

