Create a Managed Account

POST

/v2/managedCompanies

POST

/v2/managedCompanies

curl -X POST https://api.megaport.com/v2/managedCompanies \
     -H "Content-Type: application/json" \
     -d '{
  "accountName": "Best Company Ever",
  "accountRef": "555-1212-0317-1967"
}'

200Create a Managed Account

{
  "data": {
    "accountManagementEmail": "user@example.com",
    "accountName": "Best Company Ever",
    "accountRef": "555-1212-0317-1967",
    "companyId": 0,
    "companyUid": "fd404dc9-9efd-43c1-9e0b-a58a9d250130",
    "customerSuccessManagerEmail": "user@example.com",
    "resourceLimits": [
      {
        "currentCount": 8,
        "limit": 10,
        "productType": "MEGAPORT"
      }
    ],
    "techSupportEmail": "user@example.com",
    "techSupportPhone": "5551234"
  },
  "message": "New managed company has been successfully created.",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

As a Megaport Partner, use this endpoint to create a new managed company account.

The parameters are defined in the Body of the request:

accountName â€“ A unique, easily identifiable name for the account. The length can range from 1 to 128 characters (Required - string).
accountRef - A reference ID for the managed account. The accountRef is typically an identifier used in partner systems (for example, CRM or billing). This value is shown on the invoices as the Managed Account Reference. The accountRef also identifies the account in email notifications. (The accountRef value maps to the Managed Account UID in the Portal interface.) (Required - string).
techSupportEmail - The email address for technical support. This is used for communication regarding technical issues or inquiries. It should be a valid email format (Optional - string).
techSupportPhone - The phone number for technical support. This is used for communication regarding technical issues or inquiries. It should be in a valid phone number format (Optional - string).
markets - An array of objects that identify the managed account, including marketCode, currency, taxId, and taxAddress. The taxAddress object represents a Google Address DTO (Data Transfer Object). It contains various properties related to an address, such as latitude, longitude, street name, postcode, and more. Each property provides specific details about the address, which can be used in various applications or services (Optional - array).
resellerName - The name of the reseller associated with the company (Optional - string).
resourceLimits - The maximum number of services allowed to be ordered for a given product type. Resource limits can only be configured for these product types: MEGAPORT, MVE, MCR2, NAT_GATEWAY, IX, VXC (Optional - array).

A successful call returns a companyUid for the new company entry. You use the companyUid to reference this company in other API calls, and to act on behalf of the company.

Request

This endpoint expects an object.

accountNamestringOptional

accountRefstringOptional

Response

Create a Managed Account - Full Details / Create a Managed Account - Name and Reference / Create a Managed Account - Full Details / Create a Managed Account - Name and Reference

dataobjectOptional

messagestringOptional

termsstringOptional