# Alerts API

The Tidepool API is an HTTP REST API used by Tidepool clients to communicate with the Tidepool Platform.

For more information, see the [Getting Started](../docs/quick-start.md) section.

Version: 1.0
License: BSD-2-Clause

## Servers

integration
```
https://external.integration.tidepool.org
```

production
```
https://api.tidepool.org
```

dev1
```
https://dev1.dev.tidepool.org
```

qa1
```
https://qa1.development.tidepool.org
```

qa2
```
https://qa2.development.tidepool.org
```

## Security

### sessionToken

Tidepool Session Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

## Download OpenAPI description

[Alerts API](https://tidepool.redocly.app/_spec/reference/alerts.v1.yaml)

## Alerts

Endpoints related to alert configuration and management.

### Delete an alerts configuration

 - [DELETE /v1/users/{userId}/followers/{followerUserId}/alerts](https://tidepool.redocly.app/reference/alerts.v1/alerts/deletealertsconfiguration.md): Delete an existing alerts configuration.

### Get an alerts configuration

 - [GET /v1/users/{userId}/followers/{followerUserId}/alerts](https://tidepool.redocly.app/reference/alerts.v1/alerts/getalertsconfiguration.md): Retrieve an existing alerts configuration.

### Create or update an alerts configuration

 - [POST /v1/users/{userId}/followers/{followerUserId}/alerts](https://tidepool.redocly.app/reference/alerts.v1/alerts/upsertalertsconfiguration.md): Create or update an alerts configuration.
If no alerts configuration exists, it will be created.