API product catalogDeveloper Platform, Sandbox & Key Management

Replace notification policy

Developer Platform, Sandbox & Key Management

PUT

/notification-rules

Production onlyreplaceNotificationRules

Validates and replaces the partner notification rules. A maximum of 50 rules is accepted.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

rulesobject[]Required

rules[].idstring

rules[].enabledbooleanRequired

rules[].channelsstring[]Required

rules[].recipientsstring[]Required

rules[].severityall | critical | high

rules[].thresholdnumber | null

rules[].quietHoursstring | null

Response fields

messagestringRequired

rulesobject[]Required

rules[].idstring

rules[].enabledbooleanRequired

rules[].channelsstring[]Required

rules[].recipientsstring[]Required

rules[].severityall | critical | high

rules[].thresholdnumber | null

rules[].quietHoursstring | null

updatedAtstringRequired

updatedBystringRequired

Response codes

200Notification policy saved.

400Notification rule validation failed.

Request reference

Production only

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/v1/partner/notification-rules

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "message",
    "rules",
    "updatedAt",
    "updatedBy"
  ],
  "properties": {
    "message": {
      "type": "string"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "event",
          "enabled",
          "channels",
          "recipients"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 120
          },
          "event": {
            "type": "string",
            "enum": [
              "float.low",
              "reconciliation.exception",
              "webhook.failed",
              "incident.opened",
              "approval.requested",
              "kyc.review",
              "usage.threshold",
              "certification.updated"
            ]
          },
          "enabled": {
            "type": "boolean",
            "default": true
          },
          "channels": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "enum": [
                "email",
                "webhook",
                "sms"
              ]
            }
          },
          "recipients": {
            "type": "array",
            "minItems": 1,
            "maxItems": 20,
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          },
          "severity": {
            "type": "string",
            "enum": [
              "all",
              "critical",
              "high"
            ],
            "default": "all"
          },
          "threshold": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "quietHours": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 80
          }
        }
      }
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedBy": {
      "type": "string"
    }
  }
}

curl -X PUT 'https://mystocks.africa/api/v1/partner/notification-rules' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "rules": [{
    "id": "webhook-failures",
    "event": "webhook.failed",
    "enabled": true,
    "channels": ["email"],
    "recipients": ["operations@partner.example"],
    "severity": "high"
  }]
}'

GET /notification-rules

GET /openapi.json