Update a Company
curl --request PATCH \
--url https://api.tread-horizon.com/v1/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"legal_name": "Tread",
"dba_name": "<string>",
"address": {
"thoroughfare": "123 Fake St.",
"premise": "3rd Floor",
"locality": "New York",
"administrative_area": "NY",
"postal_code": "10011",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>",
"_destroy": 123
},
"tread_customer": false,
"language": "en",
"date_format": "MM/DD/YYYY",
"time_format": "12-hour",
"system_of_measure": "imperial",
"unit_of_distance": "mile",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"usage_status": "demo",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"company_type": "hauler",
"fuel_surcharge_percentage": 50,
"auth_methods": [],
"ai_review_loads": true,
"default_lat": "<string>",
"default_lon": "<string>",
"site_radius": 123,
"default_geofence_delay_seconds": 123
}
'import requests
url = "https://api.tread-horizon.com/v1/companies/{id}"
payload = {
"legal_name": "Tread",
"dba_name": "<string>",
"address": {
"thoroughfare": "123 Fake St.",
"premise": "3rd Floor",
"locality": "New York",
"administrative_area": "NY",
"postal_code": "10011",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>",
"_destroy": 123
},
"tread_customer": False,
"language": "en",
"date_format": "MM/DD/YYYY",
"time_format": "12-hour",
"system_of_measure": "imperial",
"unit_of_distance": "mile",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"usage_status": "demo",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"company_type": "hauler",
"fuel_surcharge_percentage": 50,
"auth_methods": [],
"ai_review_loads": True,
"default_lat": "<string>",
"default_lon": "<string>",
"site_radius": 123,
"default_geofence_delay_seconds": 123
}
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({
legal_name: 'Tread',
dba_name: '<string>',
address: {
thoroughfare: '123 Fake St.',
premise: '3rd Floor',
locality: 'New York',
administrative_area: 'NY',
postal_code: '10011',
country: 'US',
lat: '<string>',
lon: '<string>',
place_id: '<string>',
_destroy: 123
},
tread_customer: false,
language: 'en',
date_format: 'MM/DD/YYYY',
time_format: '12-hour',
system_of_measure: 'imperial',
unit_of_distance: 'mile',
currency: 'USD',
time_zone: 'America/New_York',
primary_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
billing_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
usage_status: 'demo',
billing_status: 'unpaid',
saas_billing_plan: 'basic',
company_type: 'hauler',
fuel_surcharge_percentage: 50,
auth_methods: [],
ai_review_loads: true,
default_lat: '<string>',
default_lon: '<string>',
site_radius: 123,
default_geofence_delay_seconds: 123
})
};
fetch('https://api.tread-horizon.com/v1/companies/{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.tread-horizon.com/v1/companies/{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([
'legal_name' => 'Tread',
'dba_name' => '<string>',
'address' => [
'thoroughfare' => '123 Fake St.',
'premise' => '3rd Floor',
'locality' => 'New York',
'administrative_area' => 'NY',
'postal_code' => '10011',
'country' => 'US',
'lat' => '<string>',
'lon' => '<string>',
'place_id' => '<string>',
'_destroy' => 123
],
'tread_customer' => false,
'language' => 'en',
'date_format' => 'MM/DD/YYYY',
'time_format' => '12-hour',
'system_of_measure' => 'imperial',
'unit_of_distance' => 'mile',
'currency' => 'USD',
'time_zone' => 'America/New_York',
'primary_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'billing_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'usage_status' => 'demo',
'billing_status' => 'unpaid',
'saas_billing_plan' => 'basic',
'company_type' => 'hauler',
'fuel_surcharge_percentage' => 50,
'auth_methods' => [
],
'ai_review_loads' => true,
'default_lat' => '<string>',
'default_lon' => '<string>',
'site_radius' => 123,
'default_geofence_delay_seconds' => 123
]),
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.tread-horizon.com/v1/companies/{id}"
payload := strings.NewReader("{\n \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\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.tread-horizon.com/v1/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tread-horizon.com/v1/companies/{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 \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"dba_name": "<string>",
"tread_customer": true,
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"stytch_organization_id": "<string>",
"language": "en",
"time_format": "12-hour",
"date_format": "MM/DD/YYYY",
"unit_of_distance": "mile",
"system_of_measure": "imperial",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"logo_url": "<string>",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"usage_status": "demo",
"fuel_surcharge_percentage": "<string>",
"auth_methods": [
"sso"
],
"auto_complete_order": true,
"ai_review_loads": true,
"site_radius": "<string>",
"default_geofence_delay_seconds": 123,
"parent_company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler"
},
"default_lat": "43.648947",
"default_lon": "-79.389193"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"error_type": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"errors": [
{
"model": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Companies
Update a Company
Update a Company by ID
This endpoint requires the edit_company permission
PATCH
/
v1
/
companies
/
{id}
Update a Company
curl --request PATCH \
--url https://api.tread-horizon.com/v1/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"legal_name": "Tread",
"dba_name": "<string>",
"address": {
"thoroughfare": "123 Fake St.",
"premise": "3rd Floor",
"locality": "New York",
"administrative_area": "NY",
"postal_code": "10011",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>",
"_destroy": 123
},
"tread_customer": false,
"language": "en",
"date_format": "MM/DD/YYYY",
"time_format": "12-hour",
"system_of_measure": "imperial",
"unit_of_distance": "mile",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"usage_status": "demo",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"company_type": "hauler",
"fuel_surcharge_percentage": 50,
"auth_methods": [],
"ai_review_loads": true,
"default_lat": "<string>",
"default_lon": "<string>",
"site_radius": 123,
"default_geofence_delay_seconds": 123
}
'import requests
url = "https://api.tread-horizon.com/v1/companies/{id}"
payload = {
"legal_name": "Tread",
"dba_name": "<string>",
"address": {
"thoroughfare": "123 Fake St.",
"premise": "3rd Floor",
"locality": "New York",
"administrative_area": "NY",
"postal_code": "10011",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>",
"_destroy": 123
},
"tread_customer": False,
"language": "en",
"date_format": "MM/DD/YYYY",
"time_format": "12-hour",
"system_of_measure": "imperial",
"unit_of_distance": "mile",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"usage_status": "demo",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"company_type": "hauler",
"fuel_surcharge_percentage": 50,
"auth_methods": [],
"ai_review_loads": True,
"default_lat": "<string>",
"default_lon": "<string>",
"site_radius": 123,
"default_geofence_delay_seconds": 123
}
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({
legal_name: 'Tread',
dba_name: '<string>',
address: {
thoroughfare: '123 Fake St.',
premise: '3rd Floor',
locality: 'New York',
administrative_area: 'NY',
postal_code: '10011',
country: 'US',
lat: '<string>',
lon: '<string>',
place_id: '<string>',
_destroy: 123
},
tread_customer: false,
language: 'en',
date_format: 'MM/DD/YYYY',
time_format: '12-hour',
system_of_measure: 'imperial',
unit_of_distance: 'mile',
currency: 'USD',
time_zone: 'America/New_York',
primary_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
billing_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
usage_status: 'demo',
billing_status: 'unpaid',
saas_billing_plan: 'basic',
company_type: 'hauler',
fuel_surcharge_percentage: 50,
auth_methods: [],
ai_review_loads: true,
default_lat: '<string>',
default_lon: '<string>',
site_radius: 123,
default_geofence_delay_seconds: 123
})
};
fetch('https://api.tread-horizon.com/v1/companies/{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.tread-horizon.com/v1/companies/{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([
'legal_name' => 'Tread',
'dba_name' => '<string>',
'address' => [
'thoroughfare' => '123 Fake St.',
'premise' => '3rd Floor',
'locality' => 'New York',
'administrative_area' => 'NY',
'postal_code' => '10011',
'country' => 'US',
'lat' => '<string>',
'lon' => '<string>',
'place_id' => '<string>',
'_destroy' => 123
],
'tread_customer' => false,
'language' => 'en',
'date_format' => 'MM/DD/YYYY',
'time_format' => '12-hour',
'system_of_measure' => 'imperial',
'unit_of_distance' => 'mile',
'currency' => 'USD',
'time_zone' => 'America/New_York',
'primary_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'billing_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'usage_status' => 'demo',
'billing_status' => 'unpaid',
'saas_billing_plan' => 'basic',
'company_type' => 'hauler',
'fuel_surcharge_percentage' => 50,
'auth_methods' => [
],
'ai_review_loads' => true,
'default_lat' => '<string>',
'default_lon' => '<string>',
'site_radius' => 123,
'default_geofence_delay_seconds' => 123
]),
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.tread-horizon.com/v1/companies/{id}"
payload := strings.NewReader("{\n \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\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.tread-horizon.com/v1/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tread-horizon.com/v1/companies/{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 \"legal_name\": \"Tread\",\n \"dba_name\": \"<string>\",\n \"address\": {\n \"thoroughfare\": \"123 Fake St.\",\n \"premise\": \"3rd Floor\",\n \"locality\": \"New York\",\n \"administrative_area\": \"NY\",\n \"postal_code\": \"10011\",\n \"country\": \"US\",\n \"lat\": \"<string>\",\n \"lon\": \"<string>\",\n \"place_id\": \"<string>\",\n \"_destroy\": 123\n },\n \"tread_customer\": false,\n \"language\": \"en\",\n \"date_format\": \"MM/DD/YYYY\",\n \"time_format\": \"12-hour\",\n \"system_of_measure\": \"imperial\",\n \"unit_of_distance\": \"mile\",\n \"currency\": \"USD\",\n \"time_zone\": \"America/New_York\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"usage_status\": \"demo\",\n \"billing_status\": \"unpaid\",\n \"saas_billing_plan\": \"basic\",\n \"company_type\": \"hauler\",\n \"fuel_surcharge_percentage\": 50,\n \"auth_methods\": [],\n \"ai_review_loads\": true,\n \"default_lat\": \"<string>\",\n \"default_lon\": \"<string>\",\n \"site_radius\": 123,\n \"default_geofence_delay_seconds\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"dba_name": "<string>",
"tread_customer": true,
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"stytch_organization_id": "<string>",
"language": "en",
"time_format": "12-hour",
"date_format": "MM/DD/YYYY",
"unit_of_distance": "mile",
"system_of_measure": "imperial",
"currency": "USD",
"time_zone": "America/New_York",
"primary_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"logo_url": "<string>",
"billing_status": "unpaid",
"saas_billing_plan": "basic",
"usage_status": "demo",
"fuel_surcharge_percentage": "<string>",
"auth_methods": [
"sso"
],
"auto_complete_order": true,
"ai_review_loads": true,
"site_radius": "<string>",
"default_geofence_delay_seconds": 123,
"parent_company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler"
},
"default_lat": "43.648947",
"default_lon": "-79.389193"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"error_type": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"errors": [
{
"model": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
Example:
"en"
Path Parameters
Company ID
Body
application/json
Note that all parameters are optional - a caller need only provide the Company fields that they wish to change.
Legal registered name of the Company - used for billing. Must be globally unique
Example:
"Tread"
Doing Business As name. Must be globally unique
Show child attributes
Show child attributes
Flag indicating that this Company is a customer of Tread
Supported ISO 639-1 Language Codes
Available options:
en, es, fr Example:
"en"
Available options:
MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD Example:
"MM/DD/YYYY"
Available options:
12-hour, 24-hour Example:
"12-hour"
Unit system to use when displaying non-distance measurements
Available options:
imperial, metric Example:
"imperial"
Unit to use when displaying distances
Available options:
mile, kilometer Example:
"mile"
Currency
Available options:
CAD, USD Example:
"USD"
Available options:
Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Coyhaique, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0, Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT-0, Etc/GMT-1, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/Greenwich, Etc/UCT, Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Factory, GB, GB-Eire, GMT, GMT+0, GMT-0, GMT0, Greenwich, HST, Hongkong, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, ROC, ROK, Singapore, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Samoa, UTC, Universal, W-SU, WET, Zulu Example:
"America/New_York"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Usage status
Available options:
demo, onboarding, active, suspended, churned, deleted Example:
"demo"
Billing Status
Available options:
unpaid, free_trial, paid, overdue, suspended, churned Example:
"unpaid"
Available options:
basic, standard, pro Example:
"basic"
Company Type
Available options:
broker, contractor, hauler, owner_operator, producer, super Example:
"hauler"
Required range:
0 <= x <= 100Available options:
sso, magic_link, password, google_auth, microsoft_auth, otp_sms Enable AI review of loads for this company
Response
OK
Company model for reads.
Show child attributes
Show child attributes