PARTNERS

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. If not set, the company's phone number will not be changed.

enforce2FA

Boolean

Yes

An option that defines Two Factor Authentication (2FA) enforcement for all GravityZone user accounts in the company. Available values: true or false. The default value is false.

customFields

Object

Yes

An object containing the custom fields values for the company. To delete the custom fields, set it as an empty array.

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,
          "customFields":{
              "referenceID":"004562",
              "vertical":"healthcare",
              "partner_type":"platinum",
              "security_level":"high",
              "payment_status":"goodstanding"
          }
       },
       "jsonrpc": "2.0",
       "method": "updateCompanyDetails",
       "id": "60357f0e-94da-463c-ba36-f50f2ef8c34f"
  }  

Response:

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