Last updated: 3/12/2025 4:58:08 PM
Note
Note
Business role: Distributor (T1), ISP (T1)
Important
Important
This API will no longer be supported soon. You can use the Partners :: CreatePartnerOnboarding API instead.
This API is used to create a downstream partner company under the API caller's company.
The identity of the created partner company can be MSP or Reseller, which differ as described below:
  • MSP (Managed Service Provider): An MSP has its own business model, sells Trend Micro products and services under its own brand (white labeling), and takes the ownership of end customers and customer support. Trend Micro is responsible for supporting the MSP.
  • Reseller: A Reseller assists Trend Micro in finding customers and selling Trend Micro products and services, but Trend Micro has ownership of end customers and is responsible for customer support.
When you create a partner company, you must provide a sign-in name, which becomes the default user account in the partner company profile. This account is granted privilege as Super Administrator of the partner company. You can sign in to LMP with this sign-in name and password.
Note
Note
When the API request is processed successfully, be sure to save the partner ID, user ID, login name, and password that the API returns for further use in partner, product, and service plan management.

Request

HTTP Request

[POST] /LMPI/v2/partners

Parameters

Request Body

{
  "partner" : {
                 "type" : "MSP",
                 "name" : "Trend Micro",
                 "address" : "No.198, Sec. 2, Dunhua S. Rd., Da’an Dist.",
                 "city" : "Taipei",
                 "state" : "Taipei",
                 "postal_code" : "106",
                 "country" : "TW"
              },
                 "user" : {
                             "login_name" : "TMMSP",
                             "first_name" : "Gary",
                             "last_name" : "Wu",
                 "phone" : {
                             "area_code" : "886",
                             "number" : "2378-9666",
                             "extension" : "1"
                           },
                 "email" : "Gary_Wu@trendmicro.com",
                 "time_zone" : "Pacific Standard Time",
                 "language" : "en-US"
                 }           
}
Name
Type
Description
Validation
Required Parameters
partner.type
string
The downstream partner's role.
Possible values include:
  • MSP
  • Reseller
Valid partner type
partner.name
string
The name of the partner company.
1-128 characters
partner.state
string
The state where the partner company is located.
1-64 characters
partner.country
string
The country code of the partner company.
ISO 3166-1 alpha-2 country code
partner.city
string
The city where the partner company is located.
1-64 characters
user.login_name
string
The sign-in name of the customer's default user account.
Note
Note
This sign-in name is used to sign in to Licensing Management Portal for license, customer, and subscription 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 address.
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, used to determine the language setting of the Licensing Management Portal console.
Valid language code (e.g. en-US)
Optional Parameters
partner.address
string
The address of the partner company.
0-128 characters
partner.postal_code
string
The postal code of the partner company.
0-10 characters
partner.industry
string
The industry code of the partner company.
For more information, see Company industry codes.
0-3 characters
partner.size
string
The company size code of the partner company.
For more information, see Company size codes.
0-2 characters
partner.note
string
Additional notes on the partner company.
0-500 characters
user.phone.area_code
string
The area code of the user's contact phone number.
0-5 digits
user.phone.number
string
The user's contact phone number.
0-16 characters (limited to numbers, plus signs, minus signs, periods, and brackets)
user.phone.extension
string
The extension of the user's contact phone number.
0-10 digits

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
  "partner_id": "a7c5aa19-26ee-450c-9448-3fe445f7e26f",
  "user": {
            "id": "d5a367ac-42eb-4eba-a4f1-a9a1ae9d325d",
            "login_name": "TMMSP",
            "password": "kooe460K",
            "login_url": "https://licensingplatform.trendmicro.com/xLP/default.aspx?T=sample"
           }
}
Name
Type
Description
Length
partner_id
string
The unique identifier of the created partner company.
GUID format
user.id
string
The unique identifier of the default user account.
GUID format
user.login_name
string
The sign-in name of the default user account, used to sign in to Licensing Management Portal.
4-25 characters
user.password
date
The password of the default user account, used to sign in to Licensing Management Portal.
4-8 characters
user.login_url
string
The sign-in URL of Licensing Management Portal.
Note
Note
The URL cannot be shared, as each partner has a unique LMP URL. The value of URL query string represents the unique ID of partner company.
0-300 characters