Create Alert Preference

Creates a new alert preference for a member.

POST /digitalbanking/db-alerts/v1/users/{userId}/preferences

Create Alert Preference

cURL

curl --request POST \
  --url https://api.candescent.com/digitalbanking/db-alerts/v1/users/{userId}/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "alertType": "<string>",
  "channel": "<string>",
  "enabled": true,
  "threshold": 123
}
'

201

{
  "id": "<string>",
  "alertType": "<string>",
  "channel": "<string>",
  "enabled": true,
  "threshold": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string · required

Unique identifier of the member

Body

application/json

id · string

Unique identifier of the alert preference

alertType · string

Type of alert (LOW_BALANCE, TRANSFER_COMPLETE, LOGIN, etc.)

channel · string

Delivery channel (EMAIL, SMS, PUSH)

enabled · boolean

threshold · number

Threshold value for balance alerts

Response

201

application/json

Alert preference created

id · string

Unique identifier of the alert preference

alertType · string

Type of alert (LOW_BALANCE, TRANSFER_COMPLETE, LOGIN, etc.)

channel · string

Delivery channel (EMAIL, SMS, PUSH)

enabled · boolean

threshold · number

Threshold value for balance alerts