Update notification subscriptions

Update one or more notification subscription channel selections for the authenticated user. Valid channel keys are email, in_app, and mobile.

PUT /notifications/{user}/subscriptions

Update notification subscriptions

cURL

curl --request PUT \
  --url https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "selections": [
    {
      "notif_id": "new_message",
      "channels": {
        "email": true,
        "in_app": true,
        "mobile": false
      }
    }
  ]
}
'

200

{
  "status": "success"
}

Authorizations

Authorization · string · header · required

API access is invite-only. Contact [e-mail] to request access. Once approved, generate tokens from Account Settings → Developers. Include as: Authorization: Bearer {token}. Tokens expire after 90 days.

Path Parameters

user · string · required

Authenticated user ID or me.

Example:

"me"

Body

application/json

selections · object[] · required

Show child attributes

Response

200

application/json

Notification subscriptions updated

status · string

Example:

"success"