Views:
Last updated: 3/21/2025 10:47:27 AM
Note
Note
Business role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
This API is used to create a customer company, encompassed by your partner company, for your end customer.
When you create a customer company, you are required to provide a login name which is included in the customer profile as the default user account. This account is granted privilege as Super Administrator of the customer company.
Note
Note
When the request is processed successfully, you must save the customer ID and user ID that the API returns. The customer ID and user ID are necessary for further use in customer, user, and subscription management, and for sending customer notifications.

Request

HTTP Request

[POST] /LMPI/v2/customers

Parameters

Request Body

{
  "company" : {
    "name" : "Stay Green Greenery",
    "address" : "160711 Ventura Blvd",
    "city" : "Encino",
    "state" : "CA",
    "postal_code" : "101",
    "country" : "US",
    "note" : "",
    "emergency_email" : "support@trendmicro.com"
  },
  "user" : {
    "login_name" : "staygreen_greenery",
    "first_name" : "James C",
    "last_name" : "Charlton",
    "phone" : {
      "area_code" : "818",
      "number" : "907-7112",
      "extension" : ""
    },
    "email" : "james.c@staygreengreenery.com",
    "time_zone" : "Pacific Standard Time",
    "language" : "en-US"
  }
}
Name
Type
Description
Validation
Required Parameters
company.name
string
The name of customer company.
1-128 characters
company.city
string
The city where customer company is located.
1-64 characters
company.state
string
The state where customer company is located.
1-64 characters
company.country
string
The country code where customer company is located.
ISO 3166-1 alpha-2 country code
user.login_name
string
The login name of default user account, used to sign in to Customer Licensing Portal for customer management.
4-25 characters (limited to letters, numbers, hyphens, and underscores)
user.first_name
string
The user's first name.
1-50 characters
user.last_name
string
The user's last name.
1-50 characters
user.email
string
The user's contact email.
1-128 characters with email format (limited to letters, numbers, hyphens, periods, underscores, and "@")
user.time_zone
string
The preferred time zone.
Valid time zone (e.g. Pacific Standard Time)
user.language
string
The preferred language code. The language setting is used to determine the language preference of Customer Licensing Portal.
Valid language code (e.g. ja-JP)
Optional Parameters
company.address
string
The address of customer company.
0-128 characters
company.postal_code
string
The postal code of customer company.
0-10 characters
company.industry
string
The industry code of the customer company.
For more information, see Company industry codes.
0-3 characters
company.size
string
The company size code of the customer company.
For more information, see Company size codes.
0-2 characters
company.note
string
Additional note of customer company.
0-500 characters
company.emergency_email
string
The emergency contact information is used for contact from Trend Micro when any critical issue of service occurs, using semicolons to separate multiple email addresses.
0-250 characters with email format (limited to letters, numbers, hyphens, periods, underscores, and "@")
user.phone.area_code
string
The area code of user's contact phone number.
0-5 digits
user.phone.number
string
The contact phone number of the user.
0-16 characters (limited to numbers, plus signs, minus signs, periods, and brackets)
user.phone.extension
string
The extension of user's contact phone number.
0-10 digits

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
  "customer_id" : "17363415-4A9F-4A01-8153-10B8F35B50B1",
  "user" : {
    "id" : "3CB3C2A5-94C5-4D57-9B97-CF4FCC47FF77",
    "login_name" : "staygreen_greenery",
    "password" : "93oap1jv0z",
    "resetpasswordURL":"https://forgetpwd-stg.trendmicro.com/ForgetPassword/ResetPassword?T=S6D1N&v=1f542d52-1da7-49ac-93c4-6e0bc54053ff"
  }
}
Name
Type
Description
Length
customer_id
string
The unique identifier of created customer company.
GUID format
user.id
string
The unique identifier of default user account.
GUID format
user.login_name
string
The login name of default user account. This login name is used to login Customer Licensing Portal.
4-25 characters
user.password
string
The password of default user account. This password is used to login Customer Licensing Portal.
4-8 characters
user.resetpasswordURL
string
The reset password URL used to reset password of user account. When LMPI creates customer company, it will randomly generate a password for user account, and the reset password URL is used to replace default password generated by LMPI. URL expires after seven days.
URL format