Register an email alert

POST

email-alerts

curl --request POST \
  --url http://localhost:3000/api/backend/email-alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "events": [],
  "reviewScores": [
    1,
    2
  ],
  "confirmDrops": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    events: [],
    reviewScores: [1, 2],
    confirmDrops: true
  })
};

fetch('http://localhost:3000/api/backend/email-alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/email-alerts"

payload = {
    "email": "[email protected]",
    "events": [],
    "reviewScores": [1, 2],
    "confirmDrops": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{}

Authorizations

Authorization

string

header

required

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

Body

application/json

string<email>

required

events

enum<string>[]

required

Minimum array length: 1

Available options:

metadata.changed,

rank.dropped,

rank.improved,

rank.milestone,

rank.first,

rank.overtaken,

review.negative,

digest.weekly,

serp.entrant,

action.opened,

chart.entered,

chart.left,

chart.milestone,

review.new

reviewScores

enum<integer>[]

The stars a review.new alert is raised for. Empty or omitted means every star.

Available options:

1,

2,

3,

4,

5

Example:

[1, 2]

confirmDrops

boolean

Response

201 - application/json

The response is of type object.

curl --request POST \
  --url http://localhost:3000/api/backend/email-alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "events": [],
  "reviewScores": [
    1,
    2
  ],
  "confirmDrops": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    events: [],
    reviewScores: [1, 2],
    confirmDrops: true
  })
};

fetch('http://localhost:3000/api/backend/email-alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/backend/email-alerts"

payload = {
    "email": "[email protected]",
    "events": [],
    "reviewScores": [1, 2],
    "confirmDrops": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{}

Overview

Endpoints

Register an email alert

Authorizations

Body

Response