Skip to main content
PATCH
/
accounts
/
{id}
Update an account (PATCH allowlist)
curl --request PATCH \
  --url https://api.arcuserp.com/v1/accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "phone_main": "<string>",
  "phone_secondary": "<string>",
  "phone_mobile": "<string>",
  "website": "<string>",
  "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_limit": 123,
  "tax_exempt": true,
  "avatax_entity_code": "<string>",
  "tax_number": "<string>",
  "default_pricing_level_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_shipping_method": "<string>",
  "enable_pro_portal": true,
  "is_active": true,
  "notes": "<string>",
  "metadata": {},
  "external_customer_id": "<string>"
}
'
import requests

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

payload = {
    "display_name": "<string>",
    "company_name": "<string>",
    "email": "<string>",
    "phone_main": "<string>",
    "phone_secondary": "<string>",
    "phone_mobile": "<string>",
    "website": "<string>",
    "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credit_limit": 123,
    "tax_exempt": True,
    "avatax_entity_code": "<string>",
    "tax_number": "<string>",
    "default_pricing_level_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_shipping_method": "<string>",
    "enable_pro_portal": True,
    "is_active": True,
    "notes": "<string>",
    "metadata": {},
    "external_customer_id": "<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({
    display_name: '<string>',
    company_name: '<string>',
    email: '<string>',
    phone_main: '<string>',
    phone_secondary: '<string>',
    phone_mobile: '<string>',
    website: '<string>',
    payment_term_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    credit_limit: 123,
    tax_exempt: true,
    avatax_entity_code: '<string>',
    tax_number: '<string>',
    default_pricing_level_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    default_shipping_method: '<string>',
    enable_pro_portal: true,
    is_active: true,
    notes: '<string>',
    metadata: {},
    external_customer_id: '<string>'
  })
};

fetch('https://api.arcuserp.com/v1/accounts/{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}",
  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([
    'display_name' => '<string>',
    'company_name' => '<string>',
    'email' => '<string>',
    'phone_main' => '<string>',
    'phone_secondary' => '<string>',
    'phone_mobile' => '<string>',
    'website' => '<string>',
    'payment_term_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'credit_limit' => 123,
    'tax_exempt' => true,
    'avatax_entity_code' => '<string>',
    'tax_number' => '<string>',
    'default_pricing_level_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'default_shipping_method' => '<string>',
    'enable_pro_portal' => true,
    'is_active' => true,
    'notes' => '<string>',
    'metadata' => [
        
    ],
    'external_customer_id' => '<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.arcuserp.com/v1/accounts/{id}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_main\": \"<string>\",\n  \"phone_secondary\": \"<string>\",\n  \"phone_mobile\": \"<string>\",\n  \"website\": \"<string>\",\n  \"payment_term_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credit_limit\": 123,\n  \"tax_exempt\": true,\n  \"avatax_entity_code\": \"<string>\",\n  \"tax_number\": \"<string>\",\n  \"default_pricing_level_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_shipping_method\": \"<string>\",\n  \"enable_pro_portal\": true,\n  \"is_active\": true,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"external_customer_id\": \"<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.arcuserp.com/v1/accounts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_main\": \"<string>\",\n  \"phone_secondary\": \"<string>\",\n  \"phone_mobile\": \"<string>\",\n  \"website\": \"<string>\",\n  \"payment_term_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credit_limit\": 123,\n  \"tax_exempt\": true,\n  \"avatax_entity_code\": \"<string>\",\n  \"tax_number\": \"<string>\",\n  \"default_pricing_level_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_shipping_method\": \"<string>\",\n  \"enable_pro_portal\": true,\n  \"is_active\": true,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"external_customer_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts/{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  \"display_name\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone_main\": \"<string>\",\n  \"phone_secondary\": \"<string>\",\n  \"phone_mobile\": \"<string>\",\n  \"website\": \"<string>\",\n  \"payment_term_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credit_limit\": 123,\n  \"tax_exempt\": true,\n  \"avatax_entity_code\": \"<string>\",\n  \"tax_number\": \"<string>\",\n  \"default_pricing_level_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"default_shipping_method\": \"<string>\",\n  \"enable_pro_portal\": true,\n  \"is_active\": true,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"external_customer_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "account",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "company_name": "<string>",
    "account_number": "<string>",
    "email": "<string>",
    "phone_main": "<string>",
    "phone_secondary": "<string>",
    "phone_mobile": "<string>",
    "website": "<string>",
    "payment_term_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credit_limit": 123,
    "credit_balance": 123,
    "is_credit_hold": true,
    "tax_exempt": true,
    "avatax_entity_code": "<string>",
    "tax_number": "<string>",
    "default_pricing_level_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_shipping_method": "<string>",
    "enable_pro_portal": true,
    "is_active": true,
    "notes": "<string>",
    "metadata": {},
    "stripe_customer_id": "<string>",
    "source_platform": "<string>",
    "external_customer_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_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"
}
{
  "code": "<string>",
  "param": "<string>"
}

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

​
id
string
required

Account UUID or account_number (e.g. ACCT-001, CUST-00042). Polymorphic lookup: if the value is not a UUID it is resolved to a UUID via accounts.account_number within the entity scope before the record is fetched. (NEW-GAP-API-V1-POLYMORPHIC-LOOKUP-CROSS-RESOURCE 2026-05-20)

Body

application/json

Partial-update payload for an account. Only present fields are applied; omit a field to leave it unchanged. entity_id, id, account_number, credit_balance, is_credit_hold, and stripe_customer_id are read-only.

​
display_name
string
​
company_name
string | null
​
email
string | null
​
phone_main
string | null
​
phone_secondary
string | null
​
phone_mobile
string | null
​
website
string | null
​
payment_term_id
string<uuid> | null
​
credit_limit
number | null
​
tax_exempt
boolean
​
avatax_entity_code
string | null
​
tax_number
string | null
​
default_pricing_level_id
string<uuid> | null
​
default_location_id
string<uuid> | null
​
default_shipping_method
string | null
​
shipping_preference
enum<string> | null
Available options:
always_freight,
always_parcel,
auto
​
enable_pro_portal
boolean
​
is_active
boolean
​
notes
string | null
​
metadata
object | null
​
external_customer_id
string | null

Response

Updated account object

​
data
object

An Arcus ERP account. Represents a customer, vendor, lead, or individual. account_type drives AR vs AP behavior: business/individual/lead = customer (AR); vendor = supplier (AP). entity_id is always from the API key (Layer 1 isolation).