{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform accounts notifications API",
    "version": "20111101"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "notifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List notifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/notifications",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "from_date",
                "value": "2024-01-01",
                "type": "query",
                "description": "Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided."
              },
              {
                "name": "to_date",
                "value": "2024-03-31",
                "type": "query",
                "description": "Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`."
        },
        {
          "info": {
            "name": "Create a notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://int-api.mx.com/users/:user_guid/notifications",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "content",
                "value": "",
                "type": "query",
                "description": "The information related to the notification."
              },
              {
                "name": "subject",
                "value": "",
                "type": "query",
                "description": "The subject related to the notification."
              }
            ]
          },
          "docs": "All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity.  No other channels are supported.  This will only have an effect for clients using an MX mobile application."
        },
        {
          "info": {
            "name": "Read notifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/notifications/:notification_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "notification_guid",
                "value": "NTF-b53294f5-2356-4782-9f81-ae064c42b40a",
                "type": "path",
                "description": "The unique identifier for notifications. Defined by MX."
              }
            ]
          },
          "docs": "Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`.\n"
        }
      ]
    }
  ],
  "bundled": true
}