Update an address

curl --request PATCH \
  --url https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "name": "<string>",
  "line1": "<string>",
  "street1": "<string>",
  "line2": "<string>",
  "street2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "region": "<string>",
  "zip": "<string>",
  "postal_code": "<string>",
  "country": "US",
  "is_commercial": true,
  "is_default": true,
  "is_default_shipping": true,
  "is_default_billing": true,
  "is_pickup": true
}
'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}"

payload = {
    "label": "<string>",
    "name": "<string>",
    "line1": "<string>",
    "street1": "<string>",
    "line2": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "region": "<string>",
    "zip": "<string>",
    "postal_code": "<string>",
    "country": "US",
    "is_commercial": True,
    "is_default": True,
    "is_default_shipping": True,
    "is_default_billing": True,
    "is_pickup": True
}
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({
    label: '<string>',
    name: '<string>',
    line1: '<string>',
    street1: '<string>',
    line2: '<string>',
    street2: '<string>',
    city: '<string>',
    state: '<string>',
    region: '<string>',
    zip: '<string>',
    postal_code: '<string>',
    country: 'US',
    is_commercial: true,
    is_default: true,
    is_default_shipping: true,
    is_default_billing: true,
    is_pickup: true
  })
};

fetch('https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_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.arcuserp.com/v1/accounts/{id}/addresses/{addr_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([
    'label' => '<string>',
    'name' => '<string>',
    'line1' => '<string>',
    'street1' => '<string>',
    'line2' => '<string>',
    'street2' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'region' => '<string>',
    'zip' => '<string>',
    'postal_code' => '<string>',
    'country' => 'US',
    'is_commercial' => true,
    'is_default' => true,
    'is_default_shipping' => true,
    'is_default_billing' => true,
    'is_pickup' => true
  ]),
  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.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\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.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}")

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  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "US",
    "is_commercial": true,
    "is_default": true,
    "is_default_shipping": true,
    "is_default_billing": true,
    "is_pickup": true,
    "is_verified_shippo": true,
    "external_source": "<string>",
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

PATCH

accounts

{id}

addresses

{addr_id}

Update an address

curl --request PATCH \
  --url https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "name": "<string>",
  "line1": "<string>",
  "street1": "<string>",
  "line2": "<string>",
  "street2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "region": "<string>",
  "zip": "<string>",
  "postal_code": "<string>",
  "country": "US",
  "is_commercial": true,
  "is_default": true,
  "is_default_shipping": true,
  "is_default_billing": true,
  "is_pickup": true
}
'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}"

payload = {
    "label": "<string>",
    "name": "<string>",
    "line1": "<string>",
    "street1": "<string>",
    "line2": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "region": "<string>",
    "zip": "<string>",
    "postal_code": "<string>",
    "country": "US",
    "is_commercial": True,
    "is_default": True,
    "is_default_shipping": True,
    "is_default_billing": True,
    "is_pickup": True
}
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({
    label: '<string>',
    name: '<string>',
    line1: '<string>',
    street1: '<string>',
    line2: '<string>',
    street2: '<string>',
    city: '<string>',
    state: '<string>',
    region: '<string>',
    zip: '<string>',
    postal_code: '<string>',
    country: 'US',
    is_commercial: true,
    is_default: true,
    is_default_shipping: true,
    is_default_billing: true,
    is_pickup: true
  })
};

fetch('https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_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.arcuserp.com/v1/accounts/{id}/addresses/{addr_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([
    'label' => '<string>',
    'name' => '<string>',
    'line1' => '<string>',
    'street1' => '<string>',
    'line2' => '<string>',
    'street2' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'region' => '<string>',
    'zip' => '<string>',
    'postal_code' => '<string>',
    'country' => 'US',
    'is_commercial' => true,
    'is_default' => true,
    'is_default_shipping' => true,
    'is_default_billing' => true,
    'is_pickup' => true
  ]),
  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.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\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.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts/{id}/addresses/{addr_id}")

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  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"line1\": \"<string>\",\n  \"street1\": \"<string>\",\n  \"line2\": \"<string>\",\n  \"street2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"region\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"postal_code\": \"<string>\",\n  \"country\": \"US\",\n  \"is_commercial\": true,\n  \"is_default\": true,\n  \"is_default_shipping\": true,\n  \"is_default_billing\": true,\n  \"is_pickup\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "US",
    "is_commercial": true,
    "is_default": true,
    "is_default_shipping": true,
    "is_default_billing": true,
    "is_pickup": true,
    "is_verified_shippo": true,
    "external_source": "<string>",
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

string<uuid>

required

addr_id

string<uuid>

required

Body

application/json

Address payload accepted by both standalone address endpoints and the atomic-create path in POST /v1/accounts. Canonical field names are preferred; Stripe-style aliases are accepted everywhere for backward compatibility.

Field aliases (all paths, all operations):

street1 accepted as alias for line1 (Stripe-style)
street2 accepted as alias for line2
region accepted as alias for state
postal_code accepted as alias for zip (Stripe-style)
address_type accepted as alias for type (migration layer)

FIX 2026-05-15 (NEW-GAP-API-V1-ADDRESS-AND-CONTACT-FIELD-MAPPING-INCONSISTENT): Aliases now work in standalone POST/PATCH endpoints (previously only worked in atomic-create).

type

enum<string>

Address type. Also accepted as address_type (alias).

Available options:

shipping,

billing

address_type

enum<string>

Alias for type. Preferred in migration contexts.

Available options:

shipping,

billing

label

string | null

name

string | null

line1

string

Street line 1. Also accepted as street1 (Stripe-style alias).

street1

string | null

Alias for line1.

line2

string | null

street2

string | null

Alias for line2.

city

string

state

string

State or province (2-letter code for US). Also accepted as region.

region

string | null

Alias for state.

zip

string

Postal/ZIP code. Also accepted as postal_code (Stripe-style alias).

postal_code

string | null

Alias for zip.

country

string

default:US

is_commercial

boolean

is_default

boolean

is_default_shipping

boolean

is_default_billing

boolean

is_pickup

boolean

Response

Updated address

data

object

A shipping or billing address for an account.

Show child attributes

Remove an address from an account Set an address as the default for its type

Overview

All Endpoints

Update an address

Authorizations

Path Parameters

Body

Response