User

Update notification preferences

Updates the authenticated user’s notification preferences. All fields are optional.

Two levels. importantEmails is the master switch — off means no transactional email at all. channels is a per-type opt-out underneath it, so a trader can keep breach emails while dropping, say, add-on activation emails.

Known types, grouped the way the apps present them:

Accounts: account_imported, account_failed, account_passed, account_expired
Risk management (the trader’s own limits): risk_loss_limit, risk_profit_target, risk_lockout, risk_trade_limit, risk_auto_liquidation
Market alerts: price_alert
Add-ons: addon_activated, addon_deactivated (e.g. the CME Market Depth add-on)

A type that is absent from channels is opted in. Every type emails by default and can be turned off individually. Category-level “turn everything off” in the apps is just a batch of per-type entries in one request — there is no separate category object.

channels is merged, not replaced — send only what changed:

{ "channels": { "price_alert": { "email": false } } }

PUT

user

notifications

preferences

Update notification preferences

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/user/notifications/preferences \
  --header 'Content-Type: application/json' \
  --data '
{
  "importantEmails": true,
  "marketingEmails": false,
  "channels": {
    "price_alert": {
      "email": false
    }
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/notifications/preferences"

payload = {
    "importantEmails": True,
    "marketingEmails": False,
    "channels": { "price_alert": { "email": False } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    importantEmails: true,
    marketingEmails: false,
    channels: {price_alert: {email: false}}
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/notifications/preferences', 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://api.hyperprop.com/platform/v1/user/notifications/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'importantEmails' => true,
    'marketingEmails' => false,
    'channels' => [
        'price_alert' => [
                'email' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.hyperprop.com/platform/v1/user/notifications/preferences"

	payload := strings.NewReader("{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}")

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

	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.put("https://api.hyperprop.com/platform/v1/user/notifications/preferences")
  .header("Content-Type", "application/json")
  .body("{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/notifications/preferences")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}"

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

{
  "success": true,
  "message": "Notification preferences updated successfully",
  "data": {
    "preferences": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "importantEmails": true,
      "marketingEmails": true,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T12:30:00.000Z"
    }
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Failed to update notification preferences",
  "code": "PREFERENCES_UPDATE_FAILED"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Body

application/json

importantEmails

boolean

Receive important account and security emails

Example:

true

marketingEmails

boolean

Receive marketing and promotional emails

Example:

false

channels

object

Per-notification-type opt-outs, keyed by notification type. Merged with what is stored, so send only the types you are changing.

Example:

{ "price_alert": { "email": false } }

Response

Notification preferences updated successfully

success

boolean

Example:

true

message

string

Example:

"Notification preferences updated successfully"

data

object

Show child attributes

⌘I

Update notification preferences

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/user/notifications/preferences \
  --header 'Content-Type: application/json' \
  --data '
{
  "importantEmails": true,
  "marketingEmails": false,
  "channels": {
    "price_alert": {
      "email": false
    }
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/notifications/preferences"

payload = {
    "importantEmails": True,
    "marketingEmails": False,
    "channels": { "price_alert": { "email": False } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    importantEmails: true,
    marketingEmails: false,
    channels: {price_alert: {email: false}}
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/notifications/preferences', 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://api.hyperprop.com/platform/v1/user/notifications/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'importantEmails' => true,
    'marketingEmails' => false,
    'channels' => [
        'price_alert' => [
                'email' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.hyperprop.com/platform/v1/user/notifications/preferences"

	payload := strings.NewReader("{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}")

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

	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.put("https://api.hyperprop.com/platform/v1/user/notifications/preferences")
  .header("Content-Type", "application/json")
  .body("{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/notifications/preferences")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"importantEmails\": true,\n  \"marketingEmails\": false,\n  \"channels\": {\n    \"price_alert\": {\n      \"email\": false\n    }\n  }\n}"

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

{
  "success": true,
  "message": "Notification preferences updated successfully",
  "data": {
    "preferences": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "importantEmails": true,
      "marketingEmails": true,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T12:30:00.000Z"
    }
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Failed to update notification preferences",
  "code": "PREFERENCES_UPDATE_FAILED"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Update notification preferences

Body

Response