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

import requests

url = "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions"

payload = { "selections": [
        {
            "notif_id": "new_message",
            "channels": {
                "email": True,
                "in_app": True,
                "mobile": False
            }
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    selections: [
      {notif_id: 'new_message', channels: {email: true, in_app: true, mobile: false}}
    ]
  })
};

fetch('https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'selections' => [
        [
                'notif_id' => 'new_message',
                'channels' => [
                                'email' => true,
                                'in_app' => true,
                                'mobile' => false
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions"

	payload := strings.NewReader("{\n  \"selections\": [\n    {\n      \"notif_id\": \"new_message\",\n      \"channels\": {\n        \"email\": true,\n        \"in_app\": true,\n        \"mobile\": false\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"selections\": [\n    {\n      \"notif_id\": \"new_message\",\n      \"channels\": {\n        \"email\": true,\n        \"in_app\": true,\n        \"mobile\": false\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"selections\": [\n    {\n      \"notif_id\": \"new_message\",\n      \"channels\": {\n        \"email\": true,\n        \"in_app\": true,\n        \"mobile\": false\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "success"
}

{
  "status": "error",
  "message": "Reason for the error",
  "errors": {
    "some_data_1": "Error message for data 1",
    "some_data_2": "Error message for data 2"
  }
}

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"