Skip to content
Xaalis

Update merchant-wide notification preferences (owner only; security mandatory)

PATCH
/dashboard/v1/merchants/{merchantId}/{mode}/notification-preferences
curl --request PATCH \
  --url https://api.xaalis.org/dashboard/v1/merchants/example/test/notification-preferences \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "kyc": { "email": true, "whatsapp": true }, "payments": { "email": true, "whatsapp": true }, "payouts": { "email": true, "whatsapp": true }, "security": { "email": true, "whatsapp": true } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
merchantId
required
string
mode
required
string
Allowed values: test live

Header Parameters

Section titled “Header Parameters”
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
kyc
object
email
boolean
whatsapp
boolean
payments
object
email
boolean
whatsapp
boolean
payouts
object
email
boolean
whatsapp
boolean
security
object
email
boolean
whatsapp
boolean

Responses

Section titled “ Responses ”

200

Section titled “200”

Updated notification preferences

Media typeapplication/json
object
object
required
string
Allowed values: notification_preferences
id
required
string
preferences
required
object
kyc
required
object
email
required
boolean
whatsapp
required
boolean
payments
required
object
email
required
boolean
whatsapp
required
boolean
payouts
required
object
email
required
boolean
whatsapp
required
boolean
security
required
object
email
required
boolean
whatsapp
required
boolean
Example
{
  "object": "notification_preferences",
  "preferences": {
    "security": {
      "email": true,
      "whatsapp": true
    }
  }
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Rate limiter or service unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}