Update a company
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Corporation",
"client_type": {
"id": 123,
"name": "Retail"
},
"price_level": {
"id": 123,
"name": "Wholesale"
},
"parent_company_id": 456,
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"phone": "555-123-4567",
"fein": "12-3456789",
"tax_exempt": false,
"notes": "Key account, requires special handling",
"payment_term": "Net 30",
"due_date_days": 45,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"tags": [
"wholesale",
"preferred"
],
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com"
}
],
"sales_channel": {
"id": 12,
"label": "Wholesale"
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}"
payload = {
"name": "Acme Corporation",
"client_type": {
"id": 123,
"name": "Retail"
},
"price_level": {
"id": 123,
"name": "Wholesale"
},
"parent_company_id": 456,
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"phone": "555-123-4567",
"fein": "12-3456789",
"tax_exempt": False,
"notes": "Key account, requires special handling",
"payment_term": "Net 30",
"due_date_days": 45,
"header_discount_enabled": False,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"tags": ["wholesale", "preferred"],
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com"
}
],
"sales_channel": {
"id": 12,
"label": "Wholesale"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
client_type: {id: 123, name: 'Retail'},
price_level: {id: 123, name: 'Wholesale'},
parent_company_id: 456,
address: '123 Main St',
address_line_2: 'Suite 500',
city: 'Austin',
state: 'TX',
postal_code: '78701',
country: 'USA',
phone: '555-123-4567',
fein: '12-3456789',
tax_exempt: false,
notes: 'Key account, requires special handling',
payment_term: 'Net 30',
due_date_days: 45,
header_discount_enabled: false,
header_discount_type: 'PERCENT',
header_discount_value: 5,
header_discount_effective_from: '2026-01-01',
tags: ['wholesale', 'preferred'],
custom_fields: {Industry: 'Manufacturing', Region: 'Southwest'},
assigned_sales_reps: [{id: 42, email: 'rep@example.com'}],
sales_channel: {id: 12, label: 'Wholesale'}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}', 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://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Corporation',
'client_type' => [
'id' => 123,
'name' => 'Retail'
],
'price_level' => [
'id' => 123,
'name' => 'Wholesale'
],
'parent_company_id' => 456,
'address' => '123 Main St',
'address_line_2' => 'Suite 500',
'city' => 'Austin',
'state' => 'TX',
'postal_code' => '78701',
'country' => 'USA',
'phone' => '555-123-4567',
'fein' => '12-3456789',
'tax_exempt' => false,
'notes' => 'Key account, requires special handling',
'payment_term' => 'Net 30',
'due_date_days' => 45,
'header_discount_enabled' => false,
'header_discount_type' => 'PERCENT',
'header_discount_value' => 5,
'header_discount_effective_from' => '2026-01-01',
'tags' => [
'wholesale',
'preferred'
],
'custom_fields' => [
'Industry' => 'Manufacturing',
'Region' => 'Southwest'
],
'assigned_sales_reps' => [
[
'id' => 42,
'email' => 'rep@example.com'
]
],
'sales_channel' => [
'id' => 12,
'label' => 'Wholesale'
]
]),
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://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "Forbidden",
"message": "You do not have permission to access this resource",
"status_code": 403
}{
"error": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}{
"message": "<string>",
"errors": {}
}Companies
Update a company
Update an existing company’s information
POST
/
companies
/
{companyId}
Update a company
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Corporation",
"client_type": {
"id": 123,
"name": "Retail"
},
"price_level": {
"id": 123,
"name": "Wholesale"
},
"parent_company_id": 456,
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"phone": "555-123-4567",
"fein": "12-3456789",
"tax_exempt": false,
"notes": "Key account, requires special handling",
"payment_term": "Net 30",
"due_date_days": 45,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"tags": [
"wholesale",
"preferred"
],
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com"
}
],
"sales_channel": {
"id": 12,
"label": "Wholesale"
}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}"
payload = {
"name": "Acme Corporation",
"client_type": {
"id": 123,
"name": "Retail"
},
"price_level": {
"id": 123,
"name": "Wholesale"
},
"parent_company_id": 456,
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"phone": "555-123-4567",
"fein": "12-3456789",
"tax_exempt": False,
"notes": "Key account, requires special handling",
"payment_term": "Net 30",
"due_date_days": 45,
"header_discount_enabled": False,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"tags": ["wholesale", "preferred"],
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com"
}
],
"sales_channel": {
"id": 12,
"label": "Wholesale"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
client_type: {id: 123, name: 'Retail'},
price_level: {id: 123, name: 'Wholesale'},
parent_company_id: 456,
address: '123 Main St',
address_line_2: 'Suite 500',
city: 'Austin',
state: 'TX',
postal_code: '78701',
country: 'USA',
phone: '555-123-4567',
fein: '12-3456789',
tax_exempt: false,
notes: 'Key account, requires special handling',
payment_term: 'Net 30',
due_date_days: 45,
header_discount_enabled: false,
header_discount_type: 'PERCENT',
header_discount_value: 5,
header_discount_effective_from: '2026-01-01',
tags: ['wholesale', 'preferred'],
custom_fields: {Industry: 'Manufacturing', Region: 'Southwest'},
assigned_sales_reps: [{id: 42, email: 'rep@example.com'}],
sales_channel: {id: 12, label: 'Wholesale'}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}', 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://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Corporation',
'client_type' => [
'id' => 123,
'name' => 'Retail'
],
'price_level' => [
'id' => 123,
'name' => 'Wholesale'
],
'parent_company_id' => 456,
'address' => '123 Main St',
'address_line_2' => 'Suite 500',
'city' => 'Austin',
'state' => 'TX',
'postal_code' => '78701',
'country' => 'USA',
'phone' => '555-123-4567',
'fein' => '12-3456789',
'tax_exempt' => false,
'notes' => 'Key account, requires special handling',
'payment_term' => 'Net 30',
'due_date_days' => 45,
'header_discount_enabled' => false,
'header_discount_type' => 'PERCENT',
'header_discount_value' => 5,
'header_discount_effective_from' => '2026-01-01',
'tags' => [
'wholesale',
'preferred'
],
'custom_fields' => [
'Industry' => 'Manufacturing',
'Region' => 'Southwest'
],
'assigned_sales_reps' => [
[
'id' => 42,
'email' => 'rep@example.com'
]
],
'sales_channel' => [
'id' => 12,
'label' => 'Wholesale'
]
]),
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://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"client_type\": {\n \"id\": 123,\n \"name\": \"Retail\"\n },\n \"price_level\": {\n \"id\": 123,\n \"name\": \"Wholesale\"\n },\n \"parent_company_id\": 456,\n \"address\": \"123 Main St\",\n \"address_line_2\": \"Suite 500\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postal_code\": \"78701\",\n \"country\": \"USA\",\n \"phone\": \"555-123-4567\",\n \"fein\": \"12-3456789\",\n \"tax_exempt\": false,\n \"notes\": \"Key account, requires special handling\",\n \"payment_term\": \"Net 30\",\n \"due_date_days\": 45,\n \"header_discount_enabled\": false,\n \"header_discount_type\": \"PERCENT\",\n \"header_discount_value\": 5,\n \"header_discount_effective_from\": \"2026-01-01\",\n \"tags\": [\n \"wholesale\",\n \"preferred\"\n ],\n \"custom_fields\": {\n \"Industry\": \"Manufacturing\",\n \"Region\": \"Southwest\"\n },\n \"assigned_sales_reps\": [\n {\n \"id\": 42,\n \"email\": \"rep@example.com\"\n }\n ],\n \"sales_channel\": {\n \"id\": 12,\n \"label\": \"Wholesale\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123456,
"status": "active",
"name": "Acme Corporation",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"type": "Retail",
"phone": "555-123-4567",
"address": "123 Main St",
"address_line_2": "Suite 500",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "USA",
"full_address": "123 Main St, Suite 500, Austin, TX 78701, USA",
"shipping_first_name": "John",
"shipping_last_name": "Doe",
"shipping_email": "shipping@acmecorp.com",
"shipping_phone": "555-987-6543",
"shipping_address": "456 Warehouse Blvd",
"shipping_city": "Austin",
"shipping_state": "TX",
"shipping_postal_code": "78745",
"shipping_country": "USA",
"shipping_full_address": "456 Warehouse Blvd, Austin, TX 78745, USA",
"payment_term": "Net 30",
"tax_exempt": false,
"tax_rate": 8.25,
"due_date_days": 30,
"header_discount_enabled": false,
"header_discount_type": "PERCENT",
"header_discount_value": 5,
"header_discount_effective_from": "2026-01-01",
"price_level": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"name": "Wholesale",
"type": "percentage",
"percent_increase": 15.5
},
"notes": "Key account, requires special handling",
"fein": "12-3456789",
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
],
"default_shipping": {
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
},
"shipping_addresses": [
{
"id": 789,
"company_id": 123456,
"address": "456 Warehouse Blvd",
"city": "Austin",
"state": "TX",
"postal_code": "78745",
"country": "USA",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"company_name": "Acme Corporation",
"address_line_2": "Building 2",
"full_address": "456 Warehouse Blvd, Building 2, Austin, TX 78745, USA",
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"phone": "555-987-6543",
"email": "shipping@acmecorp.com",
"is_default": true
}
],
"billing_info": {
"id": 456,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"first_name": "Jane",
"last_name": "Smith",
"email": "accounting@acmecorp.com",
"receiving_bank_name": "First National Bank",
"receiving_bank_address": "789 Finance Street, Austin, TX 78701"
},
"client_type": {
"id": 123,
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"name": "Retail",
"description": "Retail business client"
},
"parent_company_id": 456,
"invoice_export_template_id": 789,
"custom_fields": {
"Industry": "Manufacturing",
"Region": "Southwest",
"Annual Revenue": "$5M-$10M"
},
"assigned_sales_reps": [
{
"id": 42,
"email": "rep@example.com",
"first_name": "Jane",
"last_name": "Doe"
}
],
"sales_channel": {
"id": 123,
"status": "<string>",
"label": "<string>",
"channel_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "Forbidden",
"message": "You do not have permission to access this resource",
"status_code": 403
}{
"error": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
The unique identifier of the company
Body
application/json
Company name
Maximum string length:
255Example:
"Acme Corporation"
Client type information. Can provide either id or name. If name is provided and type doesn't exist, it will be created.
Show child attributes
Show child attributes
Default price level to assign to the company. Provide either id or name;
id takes precedence. The price level must already exist and be active —
unlike client_type, price levels are never auto-created (they are
admin-configured entities with percent_increase values). A non-matching
id or name returns a 422. Omit the field to leave it unchanged.
Show child attributes
Show child attributes
ID of the parent company
Example:
456
Street address for the company
Maximum string length:
255Example:
"123 Main St"
Additional address information
Maximum string length:
255Example:
"Suite 500"
City
Maximum string length:
255Example:
"Austin"
State/province
Maximum string length:
255Example:
"TX"
Postal/ZIP code
Maximum string length:
255Example:
"78701"
Country
Maximum string length:
255Example:
"USA"
Primary phone number for the company
Maximum string length:
255Example:
"555-123-4567"
Federal Employer Identification Number
Maximum string length:
255Example:
"12-3456789"
Whether the company is exempt from taxes
Example:
false
Additional notes about the company
Example:
"Key account, requires special handling"
Payment terms label (e.g. "Net 30"). Must match a supported payment term.
Example:
"Net 30"
Number of days until payment is due (used when payment_term is "Custom")
Required range:
x >= 0Example:
45
Whether to apply an order-header trade discount by default for this company
Example:
false
How the header discount is calculated — a percentage of the order or a fixed amount
Available options:
PERCENT, FIXED_AMOUNT Example:
"PERCENT"
The header discount amount — a percentage when header_discount_type is PERCENT, otherwise a fixed currency amount
Required range:
x >= 0Example:
5
Date from which the header discount takes effect (YYYY-MM-DD)
Example:
"2026-01-01"
List of tags to associate with the company
Maximum string length:
255Example:
["wholesale", "preferred"]
Custom field values for the company
Show child attributes
Show child attributes
Example:
{
"Industry": "Manufacturing",
"Region": "Southwest"
}
Sales rep users (Go Team members) assigned to this company. Each entry must
include id or email. Passing this field syncs the list — entries not present
are removed. Pass an empty array to clear all assignments. Omit the field to
leave the current assignments unchanged.
Show child attributes
Show child attributes
Set the company's default sales channel. Provide id or label to match an
existing active channel — id takes precedence. Channels are never auto-created.
Pass an explicit null to clear the assignment.
Show child attributes
Show child attributes
Response
Company successfully updated
Show child attributes
Show child attributes
⌘I