ESET Online Help

Search
Select the topic

MSP

Call description

Use this request to change or update the properties of an existing MSP company.

This API call requires authorization; the user has to be logged in.

Request URL: https://mspapi.eset.com/api/Company/Update/msp

This request is a POST call type.

How Update calls work

When updating the company properties using an Update call:

Each value in the Update request replaces the existing value in the updated object (company).

Parameters with no value (but not excluded from the request) erase the original value in the updated object.

If the parameter is excluded (omitted) in the call, the updated object keeps the original value for that parameter.

The companyId parameter is used to identify the company to update. It is the only mandatory parameter in Update calls.

Call structure

{

  "manager": true,

  "reseller": true,

  "divisionId": "string",

  "email": "string",

  "trialLicenseAllowed": true,

  "productsToAdd": [

    {

      "code": "string"

    }

  ],

  "productsToRemove": [

    {

      "code": "string"

    }

  ],

  "address": {

    "state": "string",

    "city": "string",

    "streetAddress": "string",

    "zipCode": "string"

  },

  "tagsToAdd": [

    {

      "tag": "string"

    }

  ],

  "tagsToRemove": [

    {

      "tag": "string"

    }

  ],

  "customIdentifier": "string",

  "comment": "string",

  "vatId": "string",

  "description": "string",

  "name": "string",

  "companyId": "string"

}

Call parameters

Parameter

Description

manager

Set the manager parameter to true when creating an MSP Manager (entity type 1004). For a standard MSP company (entity type 1005), set to false.

reseller

If you set the value to true, the created/modified MSP will have reseller status in ESET license servers. Accepted values are: true and false.

divisionId


email

Email address of the user.

trialLicenseAllowed

Set if trial licenses are allowed for the new user. Use values: true / false.

address

Section for the user address information.

state

User address state of residence. Select one from the list.

city

User address city of residence.

streetAddress

User address street name.

zipCode

User address ZIP code.

tagsToRemove, tagsToAdd

tagsToRemove and tagsToAdd are update parameters; you can type in tags to be removed or added to the updated entity. Type one or more tags.

productsToAdd, productsToRemove, products, code

You can type in one or more product codes to add them (productsToAdd) or remove them (productsToRemove) from the company's selection.

customIdentifier

Identifier string.

comment

Comment field.

vatId

VAT ID or TAX ID number. If your company has selected USA as the country of residence, it uses TAX ID.

The request body always uses VAT ID, but the MSP Web portal (EMA 2) displays the correct field.

description

Description field.

name

The company name; a unique identifier for entities across EMA 2.

companyId

companyId is the unique identifier of the company you are updating. You cannot update or change the id value.

Mandatory input parameter. A proper value must be set.

Response structure

A successful call returns an empty JSON response.

hmtoggle_plus0Example response

Troubleshooting

ESET MSP Administrator 2 API uses standardized error codes. If you are getting errors or unexpected responses, see the Troubleshooting API for common problems and the list of error codes.

List of error codes