Notification settings

.md

One switch per kind of notice you receive.

Scopesnotifications:read
GET/v1/me/notifications/settings

Every kind of notice this account can receive, and whether it is on. A kind that is off is off everywhere: no row in the notification centre, nothing on the socket, no push and no mail. The switches live on the server because a push that has been sent is one the phone cannot hold back.

Which kinds are listed follows from the account. An admin of a propfirm gets the kinds their permissions let them see, such as the payouts with view_payouts, and the affiliate kinds only where the propfirm runs an affiliate programme. Propper's own staff get the platform's kinds. Every kind starts on.

Mail and the calendar are not here. A mailbox is switched off on the mailbox, and a reminder is set per appointment.

Request

curl https://api.proppertrading.com/v1/me/notifications/settings \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f"

Response

{
    "data": [
        { "object": "notification_setting", "kind": "payout_requested", "enabled": true },
        { "object": "notification_setting", "kind": "payout_awaiting_payment", "enabled": true },
        { "object": "notification_setting", "kind": "risk_flag_raised", "enabled": false },
        { "object": "notification_setting", "kind": "new_device_signed_in", "enabled": true }
    ],
    "meta": {
        "request_id": "req_01kz4bkr1aj1gv63d8fv3133ey",
        "has_more": false,
        "next_cursor": null
    }
}

kind is the type of a notice in the notification centre and the kind of an admin.notification push. The list of kinds and what each means is on the push page. A kind this app does not know yet can still be shown and switched, under its name.

Errors

StatusCodeMeaning
403insufficient_scopeThis device does not hold notifications:read