題名・タグ・共有先を変える
管理用トークンで、題名・タグ・アーカイブ・共有先を変え、文書を削除する手順。
管理用トークンで、文書の題名・タグ・アーカイブ・共有先を変えます。例では、トークンを環境変数 CR_MANAGE_TOKEN に入れています。応答には本文とコメントは入りません。
export ORIGIN=https://comment-review.fsmarketing.workers.dev
題名を変える
curl -X PATCH "$ORIGIN/api/reviews/review_example01/title" \
-H "Authorization: Bearer $CR_MANAGE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "料金ページ(第 2 稿)"}'
前後の空白は除かれ、200 文字で切られます。
タグとアーカイブを変える
curl -X PATCH "$ORIGIN/api/reviews/review_example01/meta" \
-H "Authorization: Bearer $CR_MANAGE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"addTags": ["LP"], "removeTags": ["下書き"], "archived": true}'
addTags・removeTags・archived のうち、変えるものだけを送ります。アーカイブを変えられるのはオーナーだけです。
共有先を変える
先に今の招待を読みます。応答の orgDomain が、招待できるメールアドレスのドメインです。
curl "$ORIGIN/api/reviews/review_example01/access" -H "Authorization: Bearer $CR_MANAGE_TOKEN"
招待する人と外す人を、差分で送ります。送らなかった招待には触りません。
curl -X PATCH "$ORIGIN/api/reviews/review_example01/access" \
-H "Authorization: Bearer $CR_MANAGE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"addUsers": [{"email": "hanako@example.com", "role": "viewer"}], "removeUsers": ["taro@example.com"]}'
roleはeditor(コメントを書ける)かviewer(見るだけ)です。- 1 回で合わせて 100 人までです。
- 応答の
resultに、足した人・すでに招待していた人・外した人・招待していなかった人が分かれて入ります。
文書を削除する
curl -X DELETE "$ORIGIN/api/reviews/review_example01" -H "Authorization: Bearer $CR_MANAGE_TOKEN"
削除できるのはオーナーだけです。削除した文書は元に戻せません。
項目の詳細は API リファレンス の Manage の各ページを見てください。