update company
POST/partners/companies/{company_name}Update a company's information. All fields are optional and only passed in fields will be updated. NOTE: Only Partner companies with correct permission can update companies.
Request
Path Params
company_name
string
required
Name of the company on RoscoLive to update
Example:
Acme Trucking Inc
Body Params multipart/form-data
company_city
string
optional
City
>= 1 characters
Example:
{% faker address.cityName %}
Match pattern:
^[A-Za-z]+
company_state
string
optional
State (abbrieviation or full name)
>= 2 characters
Example:
{% faker address.state %}
Match pattern:
^[A-Za-z]+
company_zipcode
string
optional
ZIP code or postal code
<= 6 characters
Example:
{% faker address.zipCode %}
Match pattern:
^[A-Za-z0-9]+
company_address
string
optional
Primary address
Example:
{% faker address.streetAddress %}
Match pattern:
^[A-Za-z0-9]+
company_country
string
optional
Country (abbreviation or full name)
>= 2 characters
Example:
{% faker address.country %}
Match pattern:
^[A-Za-z0-9]+
company_phone_number
string
optional
Main phone number - no formatting required
>= 10 characters<= 11 characters
Example:
5558675309
Match pattern:
^[0-9]+
company_new_name
string
optional
Update company name
>= 1 characters
Example:
{% faker company.name %}
Match pattern:
^[A-Za-z0-9]+
metadata
string
optional
Stringified JSON object that can contain any key/value pairs as long as it is valid JSON. Use this field to store additional data relevant to your application or solution.
Example:
{"foo": "bar}
industry_type
enum<string>
optional
Industry or market the company operates in.
Allowed values:
ftl_ltl_couriermedical_healthschool_educationconstructionwaste_managementmass_transitagriculturalgovernmentindustrialother
Request samples
Responses
200(200)
400(400)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
meta
object
required
code
integer
required
response
object
required
company
object
required
result
string
required
Example200
{
"meta": {
"code": 200
},
"response": {
"company": {
"active": true,
"advanced_profile_settings": false,
"asset_deletion_protection": false,
"billing_date": 7,
"company_address": "Flowers str, 2",
"company_address2": "Forest ave, 12",
"company_city": "Detroit2",
"company_country": "USA2",
"company_key": "4f593eb722",
"company_name": "TransfoTech",
"company_phone_number": "12121212",
"company_state": "Michigan2",
"company_type": "CUSTOMER",
"company_zipcode": "1121212",
"created_by": 1,
"created_by_company_id": 3,
"custom_apn": "1234567",
"data_limit": 3,
"data_usage_threshold": 1024,
"driver_recognition": "cardreader",
"event_expiration": "180",
"geotab_database": "",
"geotab_email": "sasha.kyrylenko@gmail.com",
"geotab_path": "",
"hash": "ac6631660b966741a00cd20cd5014441",
"id": 66,
"live_active": true,
"owner_company": "Rosco Vision Partner",
"partner_company": "Rosco Vision Partner",
"reformat_reminder": 0,
"status": "used",
"storage_active": true,
"timezone": "US/Central",
"token": "87443459",
"trace_active": true,
"trial_date": "Thu, 10 Oct 2019 12:01:20 GMT",
"trial_status": true,
"trial_subscribers": "end_user3@youpmail.com"
}
},
"result": "OK"
}Last modified: 2 months ago