/companies/{id}/

put

https://ship.cars/api/companies/{id}/

Updates an identified company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique ID of the company.

Body Params

slug

string

length ≤ 128

^[-a-zA-Z0-9_]+$

Unique slug of the company resource.

name

string

required

length ≤ 256

Full name of the company.

is_shipper

boolean

Indicates whether this is a shipper company.

is_carrier

boolean

Indicates whether this is a carrier company.

is_single_owner_operator

boolean

Indicates whether this is an owner-operator carrier company.

dot_number

integer

0 to 2147483647

USDOT number of the company.

mc_number

integer

0 to 2147483647

MC number of the company.

address

string

length ≤ 1024

Street name and number from the company address.

city

string

length ≤ 256

City name from the company address.

state

string

enum

Abbreviation of the state from the company address.

zip

string

length ≤ 10

Zip code from the company address.

string

length ≤ 254

Contact email address of the company.

phone_1

string

length ≤ 20

First contact number of the company.

phone_1_notes

string

length ≤ 256

Additional notes about the first contact number.

phone_1_type

string

enum

Type of the first contact number.

Allowed:

phone_2

string

length ≤ 20

Second contact number of the company.

phone_2_notes

string

length ≤ 256

Additional notes about the second contact number.

phone_2_type

string

enum

Type of the second contact number.

Allowed:

phone_3

string

length ≤ 20

Third contact number of the company.

phone_3_notes

string

length ≤ 256

Additional notes about the third contact number.

phone_3_type

string

enum

Type of the third contact number.

Allowed:

accounting_email

string

length ≤ 254

Contact email address for accounting purposes.

accounting_phone_1

string

length ≤ 20

First contact number for accounting purposes.

accounting_phone_1_notes

string

length ≤ 256

Additional notes about the first contact number for accounting purposes.

accounting_phone_1_type

string

enum

Type of the first contact number for accounting purposes.

Allowed:

accounting_phone_2

string

length ≤ 20

Second contact number for accounting purposes.

accounting_phone_2_notes

string

length ≤ 256

Additional notes about the second contact number for accounting purposes.

accounting_phone_2_type

string

enum

Type of the second contact number for accounting purposes.

Allowed:

accounting_phone_3

string

length ≤ 20

Third contact number for accounting purposes.

accounting_phone_3_notes

string

length ≤ 256

Additional notes about the third contact number for accounting purposes.

accounting_phone_3_type

string

enum

Type of the third contact number for accounting purposes.

Allowed:

accounting_address

string

length ≤ 1024

Street name and number from the company address for accounting purposes.

accounting_city

string

length ≤ 256

City name from the company address for accounting purposes.

accounting_state

string

enum

Abbreviation of the state from the company address for accounting purposes.

accounting_zip

string

length ≤ 10

Zip code from the company address for accounting purposes.

hide_user_list

boolean

Defaults to true

Indicates whether users list should be available for all company employees.

email_notifications_enabled

boolean

Defaults to true

Indicates whether the company should receive email notification on the email address on file. Currently applicable only for shippers.

test

boolean

Indicates whether this is a test company.

internal_link_format

uri

length ≤ 256

Format of the internal links for loads from the company's external system in which the placeholder for the load identifier is represented by braces.

invoice_enabled

boolean

Indicates whether the automatic invoice generation is enabled for the company.

invoice_prefix

string

length ≤ 5

Prefix that is appended to reference numbers of the invoices generated for the company.

next_invoice_number

integer

required

0 to 2147483647

Reference number of the next invoice generated for the company.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found