create a company
PUT
https://fleet.roscolive.com/api/v1.0/partners/companies/{new_company_name}
company
| Role | Permission |
|---|---|
| Partner | |
| Partner View | |
| Custom Partner | |
| Fleet Manager | |
| Group Manager | |
| User | |
| Custom User |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/partners/companies/' \
--form 'company_city="{% faker address.cityName %}"' \
--form 'company_state="{% faker address.stateAbbr %}"' \
--form 'company_zipcode="{% faker address.zipCode %}"' \
--form 'company_address="{% faker address.streetAddress %}"' \
--form 'company_country="{% faker address.country %}"' \
--form 'phone_number="5558675309"' \
--form 'live_active=""' \
--form 'billing_date=""' \
--form 'cutoff_when_overage=""' \
--form 'storage_active=""' \
--form 'trace_active=""' \
--form 'industry_type=""' \
--form 'trial_status=""' \
--form 'trial_date=""' \
--form 'metadata=""'Response Response Example
201 - Success
{
"meta": {
"code": 201
},
"response": {
"company": {
"active": true,
"advanced_profile_settings": true,
"allow_create_company": true,
"allow_edit_company": true,
"asset_deletion_protection": false,
"billing_date": 1,
"company_address": "82103 Strosin Villages",
"company_city": "Strosinmouth",
"company_country": "Cape Verde",
"company_key": "A1B2C3D4E5",
"company_metadata": {
"data": true
},
"company_name": "Dibbert, Kertzmann and Lakin",
"company_phone_number": "(873) 915-1295 x30529",
"company_state": "New York",
"company_type": "CUSTOMER",
"company_zipcode": "58052",
"created_by": null,
"created_by_company_id": 36229,
"custom_apn": "http://joint-miracle.net",
"driver_recognition": "manual",
"event_expiration": "365",
"geotab_database": "rosco",
"geotab_email": "Deron.Miller@gmail.com",
"geotab_path": "https://frivolous-immigration.name",
"hash": "in",
"id": 2,
"industry_type": "Waste Management",
"live_active": true,
"owner_company": "Rosco Vision Partner",
"partner_company": "Rosco Vision Partner",
"reformat_reminder": 6,
"status": "used",
"storage_active": true,
"token": "12345678",
"trace_active": true,
"trial_status": true,
"trial_subscribers": "example1@email.com,example2@email.com",
"using_rosco_sim": true
}
},
"result": "OK"
}Request
Path Params
new_company_name
string
required
>= 1 characters<= 128 characters
Example:
Acme Trucks Inc
Match pattern:
^[A-Za-z0-9]+
Body Params multipart/form-data
company_city
string
required
>= 1 characters
Example:
{% faker address.cityName %}
Match pattern:
^[A-Za-z]+
company_state
string
required
>= 2 characters
Example:
{% faker address.stateAbbr %}
Match pattern:
^[A-Za-z]+
company_zipcode
string
required
<= 8 characters
Example:
{% faker address.zipCode %}
Match pattern:
^[A-Za-z0-9]+
company_address
string
required
>= 1 characters
Example:
{% faker address.streetAddress %}
Match pattern:
^[A-Za-z0-9]+
company_country
string
required
>= 2 characters
Example:
{% faker address.country %}
Match pattern:
^[A-Za-z]+
phone_number
string
optional
>= 9 characters<= 10 characters
Example:
5558675309
Match pattern:
^[0-9]+
live_active
boolean
required
Default:
false
billing_date
integer
required
>= 1<= 31
cutoff_when_overage
boolean
deprecated
storage_active
boolean
required
trace_active
boolean
required
industry_type
enum<string>
required
Allowed values:
ftl_ltl_couriermedical_healthschool_educationconstructionwaste_managementmass_transitagriculturalgovernmentindustrialother
trial_status
boolean
optional
trial_date
string
optional
trial_status flag is true, set a date for end trial in format YYYYMMDDhhmmdd>= 14 characters<= 14 characters
Example:
20240706000000
Match pattern:
^[0-9]+
metadata
string
optional