Skip to navigation

Update Managed Company Details

View as Markdown

Megaport Partners can update details for their managed accounts through the API.

You identify the company by providing the companyUid as a parameter for the endpoint. This is the companyUid returned when the company was created.

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).

Path parameters

managedCompanyUidstringRequired

Request

This endpoint expects an object.
accountNamestringOptional
accountRefstringOptional
resourceLimitslist of objectsOptional
techSupportEmailstringOptional
techSupportPhonestringOptional

Response

Update Managed Company Details - Full Details / Update Managed Company Details - Name and Reference / Update Managed Company Details - Name and Reference / Update Managed Company Details - Full Details

dataobjectOptional
messagestringOptional
termsstringOptional