MSP
Call description
This request creates an MSP or MSP manager company. EMA 2 places the newly created company underneath the parent company. The parent should always be either a Distributor or a Division.
|
Email is mandatory and must be unique within EMA2. Name is mandatory and must be unique within sibling companies. Use the Children call for a list of sibling companies. |
When you create an MSP you create also a contact user.
•This API call requires authorization; the user has to be logged in.
•Request URL: https://mspapi.eset.com/api/Company/Create/msp
•This request is a POST call type.
Call structure
{
"address": {
"countryCode": "string",
"state": "string",
"city": "string",
"streetAddress": "string",
"zipCode": "string"
},
"manager": true,
"reseller": true,
"divisionId": "string",
"email": "string",
"trialLicenseAllowed": true,
"tags": [
{
"tag": "string"
}
],
"products": [
{
"code": "string"
}
],
"customIdentifier": "string",
"comment": "string",
"vatId": "string",
"description": "string",
"name": "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. If you omit this parameter, the value is 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. If you omit this parameter, the value is set to false. |
divisionId |
You can assign the new MSP to a division. Enter the division ID. You can use the call Children to see the list of available divisions (type 1003) and enter the publicId as the divisionId. |
Email address of the user. For each new MSP a new Contact user is created. Mandatory input parameter. A proper value must be set. |
|
trialLicenseAllowed |
Set if trial licenses are allowed for the new user. Use values: true / false. If you omit this parameter, the value is set to false. |
address |
Section for the user address information. Mandatory input parameter. A proper value must be set. |
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. |
countryCode |
Three-letter code identifier for the country. Use only codes from the list. Mandatory input parameter. A proper value must be set. |
tags |
Section for the tag listings. |
tag |
Enter one or more tags. The tag is a string. You do not need to define the tag before using it in a call. You can use tags later to search for companies. Setting a tag is not mandatory. If you do not want to use a tag, exclude both tag and tags parameters from the request. |
products |
Section for product codes. Mandatory input parameter. A proper value must be set. |
code |
The product codes are numeric identifiers for ESET products. The list of codes is available using the AvailableProducts call. At least one product code is required. Mandatory input parameter. A proper value must be set. |
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. Mandatory input parameter. A proper value must be set. |
Response structure
The response contains data in the JSON format. The response contains the companyID of the new MSP you created.
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.