Skip to content

Create or update an alerts configuration

Request

Create or update an alerts configuration. If no alerts configuration exists, it will be created.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the user who granted follow access.

followerUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the care partner to receive alerts.

Bodyapplication/jsonrequired
non-empty
urgentLowobject(glucosethreshold.v1)

Blood glucose measurements at or below this value will trigger an immediate and urgent alert.

lowobject(glucosethreshold.v1)

Blood glucose measurements at or below this value will trigger an alert.

highobject(glucosethreshold.v1)

Blood glucose measurements at or above this value will trigger an alert.

noCommunicationobject(delay.v1)

An alert sent when issues prevent the display of CGM data.

notLoopingobject(delay.v1)

An alert sent when the Tidepool Loop app is unable to loop.

curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/alerts.v1/v1/users/{userId}/followers/{followerUserId}/alerts' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "urgentLow": {
      "enabled": false,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "low": {
      "enabled": false,
      "delay": 0,
      "repeat": 0,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "high": {
      "enabled": false,
      "delay": 0,
      "repeat": 0,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "noCommunication": {
      "enabled": false,
      "delay": 0
    },
    "notLooping": {
      "enabled": false,
      "delay": 0
    }
  }'

Responses

OK