Set push notification token

Set or update the push notification token for the current device. Pass an empty pushToken to unsubscribe the device. Web subscriptions arrive as JSON-stringified PushSubscription; native tokens (APNs/FCM) are short strings.

PUT /api/v1/user/device

Set push notification token

cURL

curl --request PUT \
  --url https://api.hevn.finance/api/v1/user/device \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pushToken": "<string>"
}
'

import requests

url = "https://api.hevn.finance/api/v1/user/device"

payload = { "pushToken": "<string>" }
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({pushToken: '<string>'})
};

fetch('https://api.hevn.finance/api/v1/user/device', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deviceId": "<string>",
  "deviceType": "<string>",
  "deviceName": "<string>",
  "notificationToken": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

device-id · string | null

device-type · string · default: ios

device-name · string · default: ios

x-api-key · string | null

Body

application/json

Schema for setting push notification token. Device is identified by header.

pushToken · string · required

Push notification token (FCM/APNs)

deviceName · string | null

Human-readable device name

Response

200

application/json

Successful Response

Schema for device response.

id · string<uuid> · required

userId · string<uuid> · required

deviceId · string · required

deviceType · string · required

deviceName · string | null · required

notificationToken · string | null · required

isActive · boolean · required

createdAt · string<date-time> · required