共有先を変える

人を招待する・招待を外す。送った差分だけを当て、ほかの招待には触らない。1 回で合わせて 100 件まで。招待できるのは組織内のアドレス、または台帳に登録された社外・クライアントのアドレス。オーナーだけが変えられる。

PATCH/api/reviews/{reviewId}/access

Authorization

AuthorizationBearer token · headerrequired

管理用トークン。題名・タグ・アーカイブ・共有先を変える、文書を削除するのに使う。

AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Path parameters

reviewIdstringrequired

文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。

Request body

requiredapplication/json

addUsersobject[]

Show properties

Array of object

emailstringrequired

rolestringrequired

Allowed:editorviewer

removeUsersstring[]

changeUsersobject[]

すでに招待している人の役割を変える。

Show properties

Array of object

emailstring<email>required

rolestringrequired

Allowed:editorviewer

Responses

200

変えた。

reviewManagedReview

管理の操作の応答。本文とコメントは含まない。

Show properties

reviewIdstring

titlestring

tagsstring[]

archivedTsinteger | null

アーカイブした時刻（UNIX 時間のミリ秒）。アーカイブしていなければ null。

accessModestring

Allowed:linkrestricted

allowedUsersobject[]

招待した人。

Show properties

Array of object

emailstring

rolestring

Allowed:editorviewer

resultobject

当てた結果。

Show properties

addedobject[]

足した人。

Show properties

Array of object

emailstring

rolestring

Allowed:editorviewer

existingobject[]

すでに招待していた人。

Show properties

Array of object

emailstring

rolestring

Allowed:editorviewer

removedobject[]

外した人。

Show properties

Array of object

emailstring

rolestring

Allowed:editorviewer

missingstring[]

外そうとしたが招待していなかった人。

400

差分の形が違う（invalid_access_delta）か、役割が違う（invalid_invite_role）。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

台帳に登録されていないアドレスがある（invite_not_member）か、オーナーでない（forbidden）。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request

curl -X PATCH 'https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/access' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "addUsers": [
    {
      "email": "hanako@example.com",
      "role": "viewer"
    }
  ],
  "removeUsers": []
}'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/access", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"addUsers\": [\n    {\n      \"email\": \"hanako@example.com\",\n      \"role\": \"viewer\"\n    }\n  ],\n  \"removeUsers\": []\n}"
});

import requests

response = requests.patch(
    "https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/access",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"addUsers\": [\n    {\n      \"email\": \"hanako@example.com\",\n      \"role\": \"viewer\"\n    }\n  ],\n  \"removeUsers\": []\n}",
)

Response

{
  "review": {
    "reviewId": "string",
    "title": "string",
    "tags": [
      "string"
    ],
    "archivedTs": 0,
    "accessMode": "link",
    "allowedUsers": [
      {
        "email": "string",
        "role": "editor"
      }
    ]
  },
  "result": {
    "added": [
      {
        "email": "string",
        "role": "editor"
      }
    ],
    "existing": [
      {
        "email": "string",
        "role": "editor"
      }
    ],
    "removed": [
      {
        "email": "string",
        "role": "editor"
      }
    ],
    "missing": [
      "string"
    ]
  }
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}