Read this device's routine notification and urgent-alert preferences

GET

/v1/mobile/devices/current/notification-preferences

const url = 'https://api.vocapable.com/v1/mobile/devices/current/notification-preferences';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/mobile/devices/current/notification-preferences \
  --header 'Authorization: Bearer <token>'

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

MobileNotificationPreferences

Per-device native-alert preferences; no critical-alert/DND-bypass option exists.

object

urgent_alerts_enabled

Urgent Alerts Enabled

boolean

categories

MobileNotificationCategoryPreferences

Routine delivery categories; each remains an ID-only, server-authorized alert.

object

operations

Operations

boolean

default: true

booking

Booking

boolean

default: true

integration

Integration

boolean

default: true

subscription

Subscription

boolean

default: true

coach

Coach

boolean

default: true

quiet_hours

Any of:

MobileNotificationQuietHours
null

MobileNotificationQuietHours

A local-time quiet window for routine notifications only.

object

enabled

required

Enabled

boolean

start_time

required

Start Time

string

/^(?:[01][0-9]|2[0-3]):[0-5][0-9]$/

end_time

required

End Time

string

/^(?:[01][0-9]|2[0-3]):[0-5][0-9]$/

timezone

required

Timezone

string

>= 1 characters <= 120 characters

Example

{
  "urgent_alerts_enabled": false,
  "categories": {
    "operations": true,
    "booking": true,
    "integration": true,
    "subscription": true,
    "coach": true
  }
}