Create a notification

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/notifications \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://int-api.mx.com/users/{user_guid}/notifications"

payload = {}
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://int-api.mx.com/users/{user_guid}/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/notifications"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/notifications")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "notification": {
    "channel": "EMAIL",
    "content": "You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00.",
    "created_at": "2025-02-13T18:08:00+00:00",
    "deep_link_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "delivered_at": null,
    "entity_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "guid": "NTF-b53294f5-2356-4782-9f81-ae064c42b40a",
    "has_been_delivered": true,
    "has_been_viewed": false,
    "notification_type": 2,
    "subject": "Your Fees & Charges budget projection",
    "threshold": "<unknown>"
  }
}

POST

users

{user_guid}

notifications

Create a notification

curl --request POST \
  --url https://int-api.mx.com/users/{user_guid}/notifications \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://int-api.mx.com/users/{user_guid}/notifications"

payload = {}
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://int-api.mx.com/users/{user_guid}/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/notifications"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_guid}/notifications")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "notification": {
    "channel": "EMAIL",
    "content": "You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00.",
    "created_at": "2025-02-13T18:08:00+00:00",
    "deep_link_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "delivered_at": null,
    "entity_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "guid": "NTF-b53294f5-2356-4782-9f81-ae064c42b40a",
    "has_been_delivered": true,
    "has_been_viewed": false,
    "notification_type": 2,
    "subject": "Your Fees & Charges budget projection",
    "threshold": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request: -H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

Body

application/json

notification

object

Hide child attributes

notification.content

string

required

The main body of the notification text sent to the user.

Example:

"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00."

notification.subject

string

required

The notification summary text. Usually the same text used for “in-app” or SMS notifications.

Example:

"Monthly Budget Report"

Response

200 - application/json

notification

object

Hide child attributes

notification.channel

enum<string> | null

The way the notification will be delivered to the user.

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.

Available options:

EMAIL,

SMS,

PUSH,

IN_APP

Example:

"EMAIL"

notification.content

string

The main body of the notification text sent to the user.

Example:

"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $325.67 of $716.00."

notification.created_at

string

The date and time the notification was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

notification.deep_link_guid

any

The unique identifier for objects that directly trigger a notification. For example, TRANSACTION_FEE_CHARGE and TRANSACTION_EXPENSE_LARGE notification types will have a transaction guid in this field.

Example:

"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de"

notification.delivered_at

any

Date and time the notification was delivered, represented in ISO 8601 format with timestamp.

Example:

null

notification.entity_guid

any

The unique identifier of the entity that the notification is attached to.

Example:

"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de"

notification.guid

any

Unique identifier for the notification. Defined by MX.

Example:

"NTF-b53294f5-2356-4782-9f81-ae064c42b40a"

notification.has_been_delivered

any

Indicates if the notification has been delivered to the user.

Example:

true

notification.has_been_viewed

any

Indicates if the notification has been viewed by the user.

Example:

false

notification.notification_type

any

The type of notification. See Notification Types.

Example:

2

notification.subject

any

The notification summary text. Usually the same text used for “in-app” or SMS notifications.

Example:

"Your Fees & Charges budget projection"

notification.threshold

any