Skip to main content

updateCompanyDetails

This method updates the details of a company that you manage.

Parameters

Parameter	Type	Optional	Description and value requirements
`id`	String	Yes	The ID of the company to be updated. The default value is the ID of the company linked to the user who generated the API key. The value must be a 24-character hexadecimal string.
`type`	Integer	Yes	The company type. Available values: `0` for Partner companies, `1` for Customer companies. If not set, the company type will not be changed. Important You cannot change the type of your own company (the company linked to the API key that generated the request).
`name`	String	Yes	The company's new name. It must be unique. It must not exceed 64 characters. If not set, the company's name will not be changed.
`address`	String	Yes	The company's address. It must not exceed 128 characters and must not contain HTML tags. If not set, the company's address will not be changed.
`phone`	String	Yes	The company's new phone number. It must not exceed 32 characters. If not set, the company's phone number will not be changed.
`industry`	Integer	Yes	The industry the company operates in. Possible values: `0` - UNDEFINED `1` - AEROSPACE `101` - AEROSPACE_MANUFACTURING `102` - AEROSPACE_TECHNOLOGY_RESEARCH `2` - AGRICULTURE `201` - AGRICULTURE_CHEMICALS_FERTILIZERS `202` - AGRICULTURE_CROP_AND_ANIMAL_PRODUCTION `203` - AGRICULTURE_FARM_MACHINERY `204` - AGRICULTURE_FARMING `205` - AGRICULTURE_FISHING `206` - AGRICULTURE_FORESTRY `207` - AGRICULTURE_HUNTING `208` - AGRICULTURE_PRODUCTS `3` - ARTS_ENTERTAINMENT `301` - ARTS_ENTERTAINMENT_CULTURAL_ACTIVITIES `302` - ARTS_ENTERTAINMENT_GAMBLING `4` - AUTOMOTIVE `401` - AUTOMOTIVE_AUTO_TRUCK_MOTORCYCLE_PARTS `402` - AUTOMOTIVE_MACHINERY `403` - AUTOMOTIVE_MANUFACTURERS `404` - AUTOMOTIVE_MARKETING `5` - BUSINESS_ASSOCIATIONS `6` - CHEMICALS `7` - COMMERCIAL_SERVICES `701` - COMMERCIAL_SERVICES_VETERINARY `8` - CONGLOMERATE `9` - CONSTRUCTION `901` - CONSTRUCTION_CIVIL_ENGINEERING `902` - CONSTRUCTION_CONSTRUCTION_OF_BUILDINGS `903` - CONSTRUCTION_CONTRACTORS `904` - CONSTRUCTION_ENGINEERING `905` - CONSTRUCTION_MATERIALS `906` - CONSTRUCTION_SPECIALISED `907` - CONSTRUCTION_UTILITY_SYSTEMS `10` - CONSULTING `11` - CONTAINERS_PACKAGING `12` - DEFENSE `1201` - DEFENSE_SHIPBUILDING_AIRCRAFT `1202` - DEFENSE_SPACE `1203` - DEFENSE_WEAPONS `13` - EDUCATION_RESEARCH `1301` - EDUCATION_RESEARCH_SCIENTIFIC_RESEARCH_AND_DEVELOPMENT `14` - ENERGY `1401` - ENERGY_EQUIPMENT_TECHNOLOGIES `1402` - ENERGY_INFRASTRUCTURE `1403` - ENERGY_OIL_GAS_CONSUMABLE_FUELS `1404` - ENERGY_RENEWABLE_ENERGY `15` - ENGINEERING `16` - FINANCIAL_SERVICES `1601` - FINANCIAL_SERVICES_BANKS `1602` - FINANCIAL_SERVICES_DIVERSIFIED `1603` - FINANCIAL_SERVICES_INSURANCE `1604` - FINANCIAL_SERVICES_INVESTMENT `1605` - FINANCIAL_SERVICES_REAL_ESTATE `17` - FOOD_BEVERAGES `18` - GOVERNMENT `1801` - GOVERNMENT_LOCAL `1802` - GOVERNMENT_NATIONAL `1803` - GOVERNMENT_PRIVATE_CONTRACTORS `1804` - GOVERNMENT_PUBLIC_ADMINISTRATION_AND_DEFENSE `1805` - GOVERNMENT_PUBLIC_SERVICES `1806` - GOVERNMENT_REGIONAL `19` - HEALTHCARE `1901` - HEALTHCARE_EQUIPMENT_SERVICES `1902` - HEALTHCARE_PHARMACEUTICALS_BIOTECHNOLOGY_LIFE_SCIENCES `1903` - HEALTHCARE_RESEARCH `20` - HOSPITALITY_LEISURE `2001` - HOSPITALITY_LEISURE_HOTEL_MOTELS_CRUISE_LINES `2002` - HOSPITALITY_LEISURE_LEISURE_RECREATION `2003` - HOSPITALITY_LEISURE_RESTAURANT_BARS `21` - MANUFACTURING `2101` - MANUFACTURING_BASIC_METALS `2102` - MANUFACTURING_BEVERAGES `2103` - MANUFACTURING_CHEMICALS_PRODUCTS `2104` - MANUFACTURING_ELECTRICAL_EQUIPMENT `2105` - MANUFACTURING_ELECTRONICS `2106` - MANUFACTURING_FABRICATED_METAL_PRODUCTS `2107` - MANUFACTURING_FOOD_PRODUCTS `2108` - MANUFACTURING_FURNITURE `2109` - MANUFACTURING_MACHINERY_EQUIPMENT `2110` - MANUFACTURING_MOTOR_VEHICLES `2111` - MANUFACTURING_NON_METALLIC_MINERAL_PRODUCTS `2112` - MANUFACTURING_PAPER_PRODUCTS `2113` - MANUFACTURING_PETROLEUM_PRODUCTS `2114` - MANUFACTURING_PHARMACEUTICAL_PRODUCTS `2115` - MANUFACTURING_TEXTILES `2116` - MANUFACTURING_TOBACCO `2117` - MANUFACTURING_TRANSPORT `2118` - MANUFACTURING_WEARING_APPAREL `2119` - MANUFACTURING_WOOD `22` - MARINE `23` - MEDIA `2301` - MEDIA_ADVERTISING_MARKETING `2302` - MEDIA_BROADCASTING `2303` - MEDIA_ENTERTAINMENT `2304` - MEDIA_PUBLISHING `24` - MINING `2401` - MINING_COAL_AND_LIGNITE `2402` - MINING_METAL_ORES `2403` - MINING_PETROLEUM_AND_NATURAL_GAS `2404` - MINING_PRECIOUS_METALS `2405` - MINING_QUARRYING `2406` - MINING_SERVICES `25` - NON_PROFIT `26` - OFFICES_OF_LAWYERS `27` - PAPER_FOREST_PRODUCTS `28` - RETAIL `2801` - RETAIL_BEVERAGES `2802` - RETAIL_BOOKS_AND_NEWS `2803` - RETAIL_BUILDING_MATERIALS `2804` - RETAIL_CLOTHING_STORES `2805` - RETAIL_DISTRIBUTORS `2806` - RETAIL_ELECTRONIC_SHOPPING `2807` - RETAIL_ELECTRONICS `2808` - RETAIL_GASOLINE_STATIONS `2809` - RETAIL_HOME_FURNISHING `2810` - RETAIL_LUXURY_STORES `2811` - RETAIL_MULTILINE_RETAIL `2812` - RETAIL_PERSONAL_CARE_STORES `2813` - RETAIL_SPECIALTY_FOOD_STORES `2814` - RETAIL_SUPERMARKETS `2815` - RETAIL_SUPPLIES_STORES `2816` - RETAIL_VEHICLES `29` - SUPPORT_SERVICE_ACTIVITIES `2901` - SUPPORT_SERVICE_ACTIVITIES_BUSINESS_SUPPORT `2902` - SUPPORT_SERVICE_ACTIVITIES_EMPLOYMENT `2903` - SUPPORT_SERVICE_ACTIVITIES_MAINTENANCE_SERVICES `2904` - SUPPORT_SERVICE_ACTIVITIES_RENTAL_AND_LEASING `2905` - SUPPORT_SERVICE_ACTIVITIES_SECURITY_AND_INVESTIGATION `2906` - SUPPORT_SERVICE_ACTIVITIES_SOCIAL_ASSISTANCE `2907` - SUPPORT_SERVICE_ACTIVITIES_TRAVEL_AGENCY `30` - TECHNOLOGY `3001` - TECHNOLOGY_ARTIFICIAL_INTELLIGENCE `3002` - TECHNOLOGY_ELECTRONIC_EQUIPMENT_COMPONENTS `3003` - TECHNOLOGY_HARDWARE `3004` - TECHNOLOGY_IT_SERVICES `3005` - TECHNOLOGY_SECURITY `3006` - TECHNOLOGY_SEMICONDUCTORS_SEMICONDUCTOR_EQUIPMENT `3007` - TECHNOLOGY_SOFTWARE `31` - TELECOMMUNICATIONS_SERVICES `3101` - TELECOMMUNICATIONS_SERVICES_COMMUNICATIONS_INFRASTRUCTURE `3102` - TELECOMMUNICATIONS_SERVICES_INTEGRATED_TELECOMMUNICATIONS `3103` - TELECOMMUNICATIONS_SERVICES_WIRELESS_TELECOMMUNICATIONS `32` - TRANSPORTATION `3201` - TRANSPORTATION_AIR_TRANSPORTATION `3202` - TRANSPORTATION_DEEP_SEA_COASTAL_AND_GREAT_LAKES_WATER_TRANSPORTATION `3203` - TRANSPORTATION_GENERAL_FREIGHT_TRUCKING `3204` - TRANSPORTATION_INFRASTRUCTURE `3205` - TRANSPORTATION_INLAND_WATER_TRANSPORTATION `3206` - TRANSPORTATION_PIPELINE_TRANSPORTATION `3207` - TRANSPORTATION_POSTAL_AND_COURIER `3208` - TRANSPORTATION_RAIL_TRANSPORTATION `3209` - TRANSPORTATION_ROAD_TRANSPORTATION `3210` - TRANSPORTATION_SIGHTSEEING `3211` - TRANSPORTATION_URBAN_TRANSIT_SYSTEMS `3212` - TRANSPORTATION_WATER_TRANSPORTATION `33` - UTILITIES `3301` - UTILITIES_ELECTRICITY_GAS `3302` - UTILITIES_WATER_SUPPLY `34` - WHOLESALE `3401` - WHOLESALE_APPAREL `3402` - WHOLESALE_BEVERAGES `3403` - WHOLESALE_BUILDING_MATERIALS `3404` - WHOLESALE_CHEMICALS `3405` - WHOLESALE_DRUGS `3406` - WHOLESALE_ELECTRONIC_MARKETS `3407` - WHOLESALE_ELECTRONICS `3408` - WHOLESALE_FARM_PRODUCTS `3409` - WHOLESALE_GROCERY `3410` - WHOLESALE_HOME_FURNISHING `3411` - WHOLESALE_METAL_AND_MINERAL `3412` - WHOLESALE_NONDURABLE_GOODS `3413` - WHOLESALE_PETROLEUM `3414` - WHOLESALE_SUPPLIES `3415` - WHOLESALE_VEHICLES If not set, the company's industry will not be changed.
`country`	String	Yes	The company's new country of operation. The value must be in ISO 3166 format. If not set, the company's country will not be changed.
`state`	String	Yes	The company's state or primary administrative subdivision of operation. The value must be in ISO 3166 format. If not set, the company's state will not be changed.
`contactPerson`	Object	Yes	Information regarding the company's designated contact person. The object contains the following fields: `fullName` (String) - the person's first and last name. `email` (String) - their business email address. Important When updating a company that has no contact person defined, the `email` field is mandatory if you want to add one. `phoneNumber` (String) - their business phone number. `companyRole` (String) - their position in the company. If not set, the contact person's info will not be changed.
`skip2FAPeriod`	Integer	Yes	The period, defined in days, for which the users of the company can have their devices exempted from providing a two-factor code at authentication. Available values: `0` `1` `3` `7` `14` `30` `90`
`customFields`	Object	Yes	An object containing the custom fields' values for the company. To delete the custom fields, set it as an empty array. Important You cannot change custom field values for your own company (the company linked to the API key that generated the request).
`mdrContactInformation`	Object	Yes Important Applicable only to: Partner-type companies Customer-type companies with a yearly MDR license This information is mandatory when the company being updated is: An MSP who needs to be able to create Partners with MDR enabled for resale or Customers with MDR enabled for own use A Partner who needs to be enrolled in MDR and have access to the MDR portal For Customers with annual MDR licenses, this information may be updated, but cannot be removed.	The company's designated emergency contact details, intended for use by the MDR team during security events or incidents. The object may contain the following fields: `phoneNumber` (Object): The company's contact details needed to reach the organization by phone. Contains the following information: `countryPrefix` (String): The prefix for the country where the company is located. Note For countries that do not have a unique prefix, include the `countryCode` parameter as well. The following prefixes are shared by multiple countries: `+1`, `+599`, `+39`, `+7`, `+39`. `countryCode` (String): The ISO 3166-1 alpha-2 code of the country where the company is located. Note This parameter should only be used to identify the country when the company resides in a region that shares a telephone prefix with other countries. `subscriberNumber` (String): The local portion of the company’s telephone number, excluding any country prefix or national dialing code. It must contain between `3` and `15` digits (numbers only). Note Alternatively, the `phoneNumber` can be added as a string, if the company being updated is an MSP Partner. `fullName` (String): The full name of the designated emergency contact person from the company. `email` (String): The email address of the designated emergency contact person from the company. Important If the specified email address has not been previously verified, `emailVerificationCode` must also be included in the request. `emailVerificationCode` (String): The numeric code used to verify ownership of the specified email address. Note You can get this code by using the `generateEmailVerificationCode` method. `useDataFromAccount` (String): The ID of the GravityZone user account from which to import all relevant contact information, including the full name, email, and phone number. Important If the corresponding email address has not been previously verified, `emailVerificationCode` must also be included in the request. The user account must be accessible to you, meaning it belongs to any company that you manage. `useDataFromCompany` (String): The ID of a GravityZone company account from which to import all relevant contact information, including the full name, email, and phone number. Important The company account must belong to a company you manage. Important If the company being updated is a Customer with a yearly MDR license, the MDR contact information can be configured using one of the following methods: Provide only `phoneNumber`, `fullName`, and `email`, with `emailVerificationCode` when necessary. Provide only `useDataFromAccount`, with `emailVerificationCode` when necessary. Provide `useDataFromCompany` only. These methods are mutually exclusive and cannot be combined within the same request. For Partner companies, the MDR contact details can be defined exclusively through `phoneNumber`, `fullName`, and `email`, with `emailVerificationCode` when necessary.
`duplicateClosedIncidentsOnUpdate`	Boolean	Yes	When set to: `true`: Updates found on a closed incident trigger the creation of a new incident. `false`: If updates are detected on a closed incident, the incident is reopened. If not configured, it retains the value set prior to the update. Important This parameter cannot be set to `true` for Customers with an active MDR license or subscription.

Return value

This method does not return any value.

Example

Request:

{
    "params": {
        "id": "5493dcd2b1a43df00b7b23c6",
        "type": 0,
        "name": "Customer to Partner LTD",
        "address": "Str Example No 1",
        "phone": "0040740000001",
        "skip2FAPeriod": 3,
        "customFields": {
            "referenceID": "004562",
            "vertical": "healthcare",
            "partner_type": "platinum",
            "security_level": "high",
            "payment_status": "goodstanding"
        },
        "mdrContactInformation": {
            "phoneNumber": {
                "countryPrefix": "+40",
                "subscriberNumber": "112345"
            },
            "fullName": "Contact",
            "email": "mdrcontact@nebula.local",
            "emailVerificationCode": "43728676"
        },
        "duplicateClosedIncidentsOnUpdate": false
    },
    "jsonrpc": "2.0",
    "method": "updateCompanyDetails",
    "id": "60357f0e-94da-463c-ba36-f50f2ef8c34f"
}

Response:

{
    "id":"60357f0e-94da-463c-ba36-f50f2ef8c34f",
    "jsonrpc":"2.0",
    "result": null
}

In this section:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.