Skip to main content

updateCompanyDetails

This method updates the details of a company account.

Parameters

Parameter

Type

Optional

Description

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.

type

Number

Yes

The company type. Available values:

  • 0 for Partner companies,

  • 1 for Customer companies.

If not set, the company type will not be changed.

name

String

Yes

The company's name. It must be unique. If not set, the company's name will not be changed.

address

String

Yes

The company's address. If not set, the company's address will not be changed.

phone

String

Yes

The company's phone number.

industry

String

Yes

The industry the company operates in. Possible values:

  • 0 - UNDEFINED

  • 1 - AEROSPACE

  • 2 - AGRICULTURE

  • 3 - ARTS_ENTERTAINMENT

  • 4 - AUTOMOTIVE

  • 5 - BUSINESS_ASSOCIATIONS

  • 6 - CHEMICALS

  • 7 - COMMERCIAL_SERVICES

  • 8 - CONGLOMERATE

  • 9 - CONSTRUCTION

  • 10 - CONSULTING

  • 11 - CONTAINERS_PACKAGING:

  • 12 - DEFENSE

  • 13 - EDUCATION_RESEARCH

  • 14 - ENERGY

  • 15 - ENGINEERING

  • 16 - FINANCIAL_SERVICES

  • 17 - FOOD_BEVERAGES

  • 18 - GOVERNMENT

  • 19 - HEALTHCARE

  • 20 - HOSPITALITY_LEISURE

  • 21 - MANUFACTURING

  • 22 - MARINE

  • 23 - MEDIA

  • 24 - MINING

  • 25 - NON_PROFIT

  • 26 - OFFICES_OF_LAWYERS

  • 27 - PAPER_FOREST_PRODUCTS

  • 28 - RETAIL

  • 29 - SUPPORT_SERVICE_ACTIVITIES

  • 30 - TECHNOLOGY

  • 31 - TELECOMMUNICATIONS_SERVICES

  • 32 - TRANSPORTATION

  • 33 - UTILITIES

  • 34 - WHOLESALE

Default value: 0.

country

String

Yes

The company's country of operation. The value must be in ISO 3166 format. Default value: N/A.

state

String

Yes

The company's country state of operation. The value must be in ISO 3166 format. Default value: N/A.

contactPerson

Object

Yes

Contains information regarding the company's designated contact person. The object contains the following fields:

  • fullName - the person's first and last name.

  • email - their business email address.

    Important

    This field is mandatory when the contactPerson parameter is included in the request.

  • phoneNumber, their business phone number.

  • companyRole, their position in the company.

phone

String

Yes

The company's phone number. If not set, the company's phone number will not be changed.

enforce2FA

Boolean

Yes

An parameter that defines Two Factor Authentication (2FA) enforcement for all GravityZone user accounts in the company. The value is always true.

skip2FAPeriod

Number

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, and 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.

mdrContactInformation

Object

Yes

An object containing the contact information required for onboarding Partner companies.

Note

This information must be valid and it is mandatory for Partners who want to enable the MDR service for client Customer companies. This requirement does not apply to Partner companies that have had the service enabled for resell and have started the onboarding process prior to April 2024.

The object contains the following fields:

  • phone - The phone number of the designated contact person.

  • fullName - The name of the designated contact person for MDR issues.

  • email - The email address of the designated contact person.

    This address is also used to send out the verification code required to confirm and save the information added in the Contact details for MDR section. To send the email, use the generateEmailVerificationCode method.

  • emailVerificationCode - Enter the verification code received from the the generateEmailVerificationCode method.

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",
          "enforce2FA": true,
          "skip2FAPeriod": 3
          "customFields":{
              "referenceID":"004562",
              "vertical":"healthcare",
              "partner_type":"platinum",
              "security_level":"high",
              "payment_status":"goodstanding"
          }
        "mdrContactInformation": {
            "phone": "0040740000001",
            "fullName": "Bob",
            "email": "[email protected]",
            "emailVerificationCode": "12345678"
        }
       },
       "jsonrpc": "2.0",
       "method": "updateCompanyDetails",
       "id": "60357f0e-94da-463c-ba36-f50f2ef8c34f"
  }  

Response:

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