Upsert Notification Preference

Beta

PUT/v1/messaging/preferences

This endpoint is idempotent. Learn more

Creates or replaces a notification channel preference for the caller.

Permissions requiredValues:messaging:update

The role behind your API key or agent must grant every one of these permissions.

categoryoptional stringnullable

The notification category this preference applies to.

Omit (or null) to set the caller's global default. Send null to clear.

in_app_enabledboolean

Whether in-app (bell) notifications are delivered for this category.

email_enabledboolean

Whether email notifications are delivered for this category.

push_enabledboolean

Whether push notifications are delivered for this category.

digestoptional stringenumValues:instanthourlydaily

How email delivery for this category is batched. Defaults to instant.

instant: send an email as soon as an eligible notification occurs.
hourly: batch eligible notifications into a single hourly email.
daily: batch eligible notifications into a single daily email.
off: never send email for this category, even when email delivery is otherwise enabled.

idstring

Preference ID.

objectstringenumValues:notification_preference

Resource type identifier.

categorystringnullable

The notification category this preference applies to.

null for the global default that applies to all categories without a specific preference.

in_app_enabledboolean

Whether in-app (bell) notifications are delivered for this category.

email_enabledboolean

Whether email notifications are delivered for this category.

push_enabledboolean

Whether push notifications are delivered for this category.

digeststringenumValues:instanthourlydaily

How email delivery for this category is batched.

instant: send an email as soon as an eligible notification occurs.
hourly: batch eligible notifications into a single hourly email.
daily: batch eligible notifications into a single daily email.
off: never send email for this category, even when email delivery is otherwise enabled.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for Upsert Notification Preference

Upsert Notification Preference

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationPreference = await client.messaging.preferences.update({
  email_enabled: false,
  in_app_enabled: true,
  push_enabled: false,
  category: 'chat.message',
  digest: 'instant',
});

console.log(notificationPreference.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationPreference = await client.messaging.preferences.update({
  email_enabled: false,
  in_app_enabled: true,
  push_enabled: false,
  category: 'chat.message',
  digest: 'instant',
});

console.log(notificationPreference.id);

200 example

{
  "id": "nfpf_01h9z8q1w2e3r4t5y6u7nfpf",
  "object": "notification_preference",
  "category": "chat.message",
  "in_app_enabled": true,
  "email_enabled": true,
  "push_enabled": false,
  "digest": "instant",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "nfpf_01h9z8q1w2e3r4t5y6u7nfpf",
  "object": "notification_preference",
  "category": "chat.message",
  "in_app_enabled": true,
  "email_enabled": true,
  "push_enabled": false,
  "digest": "instant",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Upsert Notification Preference

Authorization

Request Body

Returns

Responses