ESET Online Help

Search
Select the topic

Customer

Call description

This request creates a customer; the last type in the hierarchy. EMA 2 places the new customer (company) under the parent company defined in the call, or under the logged in user, if a parent is not defined.

Using this call, an MSP Manager can create a customer under its trusted or untrusted Managed MSP. The EMA 2 web portal does not allows this.


important

Name is mandatory and must be unique within sibling companies. Use the Children call for  a list of sibling companies.

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

Request URL: https://mspapi.eset.com/api/Company/Create/customer

This request is a POST call type.

Call structure

{

"parentCompanyId": "string",

  "address": {

    "state": "string",

    "city": "string",

    "streetAddress": "string",

    "zipCode": "string"

  },

  "email": "string",

  "tags": [

    {

      "tag": "string"

    }

  ],

  "customIdentifier": "string",

  "comment": "string",

  "vatId": "string",

  "description": "string",

  "name": "string"

}

Call parameters

Parameter

Description

parentCompanyId

companyId of the parent company. If the parameter is left empty, the customer is created under the logged in user.

email

Email address of the user.

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.

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.

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.

You get the customer's company ID as the request.

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