Notifications

What the athlete asked to be sent

get/me/notification-preferences

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/me/notification-preferences
  • Auth: HTTP bearer

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Response

OK

kindstring required

What the notification is about. Known values: today_session, taper_start, reconnect_needed, weekly_review, pattern_heads_up. Treat unknown values as "other".

channelstring required

How it's sent. Known values: push, email. Treat unknown values as "other".

enabledboolean required

Off until the athlete turns it on.

labelstring required

A short name for the switch, for a person ("Today's session").

descriptionstring required

What turning it on sends, for a person.

Changes

No recorded changes to this operation across all 1 revision of this API.