Change Notification Settings

PUT

/v3/notificationPreferences

PUT

/v3/notificationPreferences

curl -X PUT https://api.megaport.com/v3/notificationPreferences \
     -H "Content-Type: application/json" \
     -d '{
  "emails": [
    {
      "subscribed": true,
      "subscriptionKey": "COMPANY_ACTIVATED"
    },
    {
      "subscribed": false,
      "subscriptionKey": "COMPANY_SUPPLY_NEW"
    },
    {
      "subscribed": false,
      "subscriptionKey": "COMPANY_SUPPLY_EMAIL_CHANGED"
    },
    {
      "subscribed": false,
      "subscriptionKey": "COMPANY_SUPPLY_EMAIL_REJECTED"
    },
    {
      "subscribed": false,
      "subscriptionKey": "SERVICE_SPEED"
    },
    {
      "subscribed": false,
      "subscriptionKey": "SERVICE_MAINTENANCE"
    },
    {
      "subscribed": false,
      "subscriptionKey": "SERVICE_OUTAGE"
    },
    {
      "subscribed": false,
      "subscriptionKey": "SERVICE_LIFECYCLE_CONFIGURED"
    },
    {
      "subscribed": false,
      "subscriptionKey": "SERVICE_LIFECYCLE_DECOMMISSIONED"
    },
    {
      "subscribed": true,
      "subscriptionKey": "SERVICE_LIFECYCLE_LIVE_PLUS_7_DAYS"
    }
  ]
}'

{
  "data": {
    "emails": [
      {
        "description": "When the administrator starts billing a service",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "BILLING_START_ADMIN"
      },
      {
        "description": "When a service goes live and we start billing on it",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "BILLING_START_LIVE"
      },
      {
        "description": "When a user successfully modifies the term of a service",
        "messageGroupName": "Financial",
        "subscribed": false,
        "subscriptionKey": "BILLING_SERVICE_RETERMED"
      },
      {
        "description": "When a credit card is used to pay and it is successful",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "CARD_GOOD_PAYMENT"
      },
      {
        "description": "When a credit card is used to pay and it fails for temporal issues",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "CARD_TEMP_BAD_PAYMENT"
      },
      {
        "description": "When a credit card is used to pay and it fails for permanent issues",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "CARD_PERM_BAD_PAYMENT"
      },
      {
        "description": "When a credit card has been successfully registered",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "CARD_REGISTER"
      },
      {
        "description": "When a credit card registration attempt has failed",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "CARD_REGISTER_FAILED"
      },
      {
        "description": "When a company gets activated",
        "messageGroupName": "Company",
        "subscribed": true,
        "subscriptionKey": "COMPANY_ACTIVATED"
      },
      {
        "description": "When a company market is created",
        "messageGroupName": "Company",
        "subscribed": true,
        "subscriptionKey": "COMPANY_SUPPLY_NEW"
      },
      {
        "description": "When the billing email account is edited in a market",
        "messageGroupName": "Company",
        "subscribed": true,
        "subscriptionKey": "COMPANY_SUPPLY_EMAIL_CHANGED"
      },
      {
        "description": "When the customer rejects the new email account as billing contact email",
        "messageGroupName": "Company",
        "subscribed": true,
        "subscriptionKey": "COMPANY_SUPPLY_EMAIL_REJECTED"
      },
      {
        "description": "When a new invoice is prepared for the billing market/customer",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "INVOICE_NOTIFY_CMD"
      },
      {
        "description": "When an IX service contained in an order is processed",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_IX"
      },
      {
        "description": "When a port contained in an order is processed",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_MEGAPORT"
      },
      {
        "description": "When a VXC service contained in an order is approved",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_VXC_APPROVED"
      },
      {
        "description": "When a VXC order needs approval from one end",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_VXC_PENDING"
      },
      {
        "description": "When a VXC order needs approval from one end and it's been waiting for more than 1 week",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_VXC_PENDING_PLUS_7"
      },
      {
        "description": "When a VXC order waiting for approval is rejected",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_VXC_REJECTED"
      },
      {
        "description": "When a first order created to a company and market supplier",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "COMPANY_SUPPLY_FIRST_ORDER"
      },
      {
        "description": "Reminder sent of any/all due/outstanding invoices",
        "messageGroupName": "Financial",
        "subscribed": true,
        "subscriptionKey": "PAYMENT_REMIND_CMD"
      },
      {
        "description": "When a service is configured",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_LIFECYCLE_CONFIGURED"
      },
      {
        "description": "When a service has been decommissioned",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_LIFECYCLE_DECOMMISSIONED"
      },
      {
        "description": "Service follow up email + 1 week",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_LIFECYCLE_LIVE_PLUS_7_DAYS"
      },
      {
        "description": "When a service goes down (1 mail per hour if service is flapping)",
        "messageGroupName": "Service Status",
        "subscribed": true,
        "subscriptionKey": "SERVICE_STATUS_DOWN"
      },
      {
        "description": "When a service goes up (1 mail per hour if service is flapping)",
        "messageGroupName": "Service Status",
        "subscribed": true,
        "subscriptionKey": "SERVICE_STATUS_UP"
      },
      {
        "description": "When a speed change is made that requires approval",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_SPEED"
      },
      {
        "description": "When planned works are scheduled",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_MAINTENANCE"
      },
      {
        "description": "Service Outage Notification",
        "messageGroupName": "Services",
        "subscribed": true,
        "subscriptionKey": "SERVICE_OUTAGE"
      },
      {
        "description": "When an order request is pending approval",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_REQUEST_PENDING"
      },
      {
        "description": "When an order request is approved",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_REQUEST_APPROVED"
      },
      {
        "description": "When an order request is rejected",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_REQUEST_REJECTED"
      },
      {
        "description": "When an order request fails to process",
        "messageGroupName": "Ordering",
        "subscribed": true,
        "subscriptionKey": "ORDER_REQUEST_FAILED"
      },
      {
        "description": "When a BGP session goes down in a service (1 mail per hour if the service is flapping)",
        "messageGroupName": "Service Status",
        "subscribed": true,
        "subscriptionKey": "SERVICE_EVENT_BGP_DOWN"
      },
      {
        "description": "When a BGP session goes up in a service (1 mail per hour if the service is flapping)",
        "messageGroupName": "Service Status",
        "subscribed": true,
        "subscriptionKey": "SERVICE_EVENT_BGP_UP"
      }
    ],
    "receivesChildNotifications": false
  },
  "message": "Your messaging destination has been saved",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Updates the current email notification settings for the logged-in user.

The changes are defined in the Body of the request. The request format is the same as the response received when listing the notifications using the List Notification Settings endpoint.

These parameters are required to update email notification subscription settings:

subscriptionKey - (String) The key value of the email event. Run the List Notification Settings endpoint to get the full list available for the user. For example, BILLING_START_ADMIN.
subscribed - (Boolean) Set the subscribed value to either true or false, depending on whether you want to subscribe to the email notification group. This will default to false if the subscribed value is not supplied.

Note: The 200 OK response always returns all notifications for the user even if you only send one update.

Request

This endpoint expects an object.

emailslist of objectsOptional

Response

Change Notification Settings - Subscribe to Two Notifications / Change Notification Settings - Subscribe to All Notifications to all / Change Notification Settings - Subscribe to All Notifications to all / Change Notification Settings - Subscribe to Two Notifications

dataobjectOptional

messagestringOptional

termsstringOptional

Errors

400

Bad Request Error