create a company - RoscoLive API v1.0

Create a new company.

Only Partners with correct permission can create companies. If you believe you will require permissions for this action, please contact RoscoLive support.

Roles with endpoint access

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params

new_company_name

string

required

Name of the company to be created

>= 1 characters<= 128 characters

Example:

Acme Trucks Inc

Match pattern:

^[A-Za-z0-9]+

Body Params multipart/form-data

company_city

string

required

City

>= 1 characters

Example:

{% faker address.cityName %}

Match pattern:

^[A-Za-z]+

company_state

string

required

State (full name or abbreviation)

>= 2 characters

Example:

{% faker address.stateAbbr %}

Match pattern:

^[A-Za-z]+

company_zipcode

string

required

ZIP/Postal code

<= 8 characters

Example:

{% faker address.zipCode %}

Match pattern:

^[A-Za-z0-9]+

company_address

string

required

Address

>= 1 characters

Example:

{% faker address.streetAddress %}

Match pattern:

^[A-Za-z0-9]+

company_country

string

required

Country (full name or abbreviation)

>= 2 characters

Example:

{% faker address.country %}

Match pattern:

^[A-Za-z]+

phone_number

string

optional

Phone number - no formatting necessary

>= 9 characters<= 10 characters

Example:

5558675309

Match pattern:

^[0-9]+

live_active

boolean

required

Live streaming enable

Default:

false

billing_date

integer

required

Date of each month billing cycle will begin.

>= 1<= 31

cutoff_when_overage

boolean

deprecated

storage_active

boolean

required

Cloud storage enable

trace_active

boolean

required

GPS trace storage enable

industry_type

enum<string>

required

Industry the company mainly operates in

Allowed values:

ftl_ltl_couriermedical_healthschool_educationconstructionwaste_managementmass_transitagriculturalgovernmentindustrialother

trial_status

boolean

optional

Flag for if company is trial company

trial_date

string

optional

If 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

An optional object that custom key/value pairs can be added to hold metadata about the company.

When passing this object, if the company does not already have a metadata object, one will be added, else it will be updated with the data passed in.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Create company success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

response

object

required

Contains response data

company

object (Company)

required

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
    "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"
}

🟠403Company already exists

🟠401Login Required