Skip to main content

Get Support Notification Preferences

GET 
/api/support/notification-preferences

Returns the signed-in user's own support notification switches. A user who has never saved preferences gets the defaults (in-app on, email copies on, no digest). Preferences are per user, not per tenant.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response fields (data)

  • in_app (boolean) — receive an in-app notification when an agent replies, when a ticket's status changes, or when a fix for one of your tickets ships. Default true
  • email_replies (boolean) — receive an email copy of agent replies on tickets you raised or watch. Default true
  • digest (string) — one of: none, daily. daily sends one email a day summarising what changed on your organisation's tickets (nothing is sent on days with no changes). Default none

Authentication: Bearer token with the support:read scope, or an authenticated session. Customer endpoints run in tenant context — send the X-Tenant-Id header or call from a tenant subdomain.

Request​

Responses​

OK

Response Headers
    Content-Type