Skip to content
Vocapable Developers

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

PUT
/v1/mobile/devices/current/notification-preferences
curl --request PUT \
  --url https://api.vocapable.com/v1/mobile/devices/current/notification-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "urgent_alerts_enabled": true, "categories": { "operations": true, "booking": true, "integration": true, "subscription": true, "coach": true }, "quiet_hours": { "enabled": true, "start_time": "example", "end_time": "example", "timezone": "example" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileNotificationPreferencesUpdateRequest
object
urgent_alerts_enabled
Any of:
boolean
categories
Any of:
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

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

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/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

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
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}