Delete FCM token

Remove an FCM device token for the authenticated user. This endpoint currently expects the token in a JSON request body. Some HTTP clients or intermediaries may drop bodies on DELETE requests, so clients should ensure their stack preserves the payload. Keeping the token out of the URL avoids encoding and length issues with long FCM tokens.

DELETE /fcm-tokens

Delete FCM token

cURL

curl --request DELETE \
  --url https://open.beatpass.ca/api/v1/fcm-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>"
}
'

import requests

url = "https://open.beatpass.ca/api/v1/fcm-tokens"

payload = { "token": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({token: '<string>'})
};

fetch('https://open.beatpass.ca/api/v1/fcm-tokens', 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/fcm-tokens",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'token' => '<string>'
  ]),
  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/fcm-tokens"

	payload := strings.NewReader("{\n  \"token\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://open.beatpass.ca/api/v1/fcm-tokens")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/fcm-tokens")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"<string>\"\n}"

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

200

{
  "status": "ok"
}

{
  "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.

Body

application/json

token · string · required

FCM registration token to remove.

Maximum string length: 500

Response

200

application/json

FCM token removed

status · string

Example:

"ok"