Skip to content
KataraKatara documentation

Set a notification preference

PUT
/katara/v1/notifications/preferences
curl --request PUT \
  --url https://api.katara.com/katara/v1/notifications/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "org_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "environment_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "product": "account", "category": "security", "channel": "in_app", "enabled": true, "time_zone": "example", "quiet_start": 1, "quiet_end": 1, "digest": "immediate", "snoozed_until": "2026-04-15T12:00:00Z", "version": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Required for cookie-authenticated changes. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
org_id
string format: uuid
environment_id
string format: uuid
product
required
string
Allowed values: account organization billing provider cortex synapse locus
category
required
string
Allowed values: security membership billing health usage runs evaluations approvals policy connections access expiry
channel
required
string
Allowed values: in_app email webhook push sms
enabled
required
boolean
time_zone
required
string
>= 1 characters <= 64 characters
quiet_start
integer
<= 1439
quiet_end
integer
<= 1439
digest
required
string
Allowed values: immediate hourly daily
snoozed_until
string format: date-time
version
required
integer

Responses

Section titled “Responses”

200

Section titled “200”

Current notification state.

Media typeapplication/json
object
org_id
string format: uuid
environment_id
string format: uuid
product
required
string
Allowed values: account organization billing provider cortex synapse locus
category
required
string
Allowed values: security membership billing health usage runs evaluations approvals policy connections access expiry
channel
required
string
Allowed values: in_app email webhook push sms
enabled
required
boolean
time_zone
required
string
>= 1 characters <= 64 characters
quiet_start
integer
<= 1439
quiet_end
integer
<= 1439
digest
required
string
Allowed values: immediate hourly daily
snoozed_until
string format: date-time
version
required
integer
Example
{
  "product": "account",
  "category": "security",
  "channel": "in_app",
  "digest": "immediate"
}

400

Section titled “400”

Invalid request.

403

Section titled “403”

A current human session or permission is required.

404

Section titled “404”

Item or source access is unavailable.

409

Section titled “409”

The state version changed; reload before editing.