Register a push subscription (web push or APNs)

POST

/api/notifications/subscribe

• Production
• Local Development

Authorizations

• bearerAuth

Request Body

Any of:

object

object

transport

string

default: web_push

Allowed values: web_push

endpoint

required

string format: uri

keys

required

object

p256dh

required

string

>= 1 characters

auth

required

string

>= 1 characters

deviceName

string

object

object

transport

required

string

Allowed values: apns

deviceToken

required

string

>= 1 characters

deviceName

string

Responses

200

Subscription registered

object

ok

required

boolean

data

required

object

id

required

string

subscribed

required

boolean

transport

required

string

Allowed values: apns web_push

400

Invalid subscription data or no band membership

object

ok

required

boolean

error

required

string

code

string

401

Unauthenticated

object

ok

required

boolean

error

required

string

code

string

403

Forbidden / no permission

object

ok

required

boolean

error

required

string

code

string

500

Failed to save subscription

object

ok

required

boolean

error

required

string

code

string