PATCH/api/push/preferences
「プッシュ通知」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。
- 要約
受け取り設定を変える(書いた種類と「通知に内容を表示」だけ)
- 呼び方と印
ログイン
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
kinds任意record<boolean>showPreview任意boolean
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
enabledbooleankindsrecord<boolean>showPreviewbooleandevicesarray<object>idstringkindstringuserAgentstring | nullcreatedAtstringlastSuccessAtstring | nullfailureCountintegeractiveboolean
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X PATCH "https://bounty.spikes.4s.link/api/push/preferences" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{}'