メインコンテンツへスキップ
POST
ワークスペースにメンバーを追加
このエンドポイントには workspaces:write 権限を持つ管理APIキーと、オーナーまたは管理者のロールが必要です。
ワークスペースへの参加は招待を通じて行います。招待を承諾すると参加リクエストが作成され、このエンドポイントがそれを承認します。user_ids の各ユーザーには、ワークスペースに保留中の参加リクエストが必要です。それ以外のユーザーは拒否されるため、先に招待を送ってください。既存のメンバーのロールは変わりません。 ロールには admin または member を指定できます。ロールを指定しない場合、各ユーザーには招待作成時のロールが付与されます。管理者を追加できるのはワークスペースのオーナーだけで、このエンドポイントではワークスペースの所有権を割り当てられません。 各ユーザーは個別に承認されます。途中で承認に失敗した場合、それまでに承認されたユーザーはワークスペースに残り、残りのユーザーは試行されません。その場合のレスポンスは 409 で、approved、failed、not_attempted の各リストで処理が止まった位置がわかります。問題を解決してから、残りのユーザーを再度送信してください。

承認

Authorization
string
header
必須

Bearer トークンによる認証

パスパラメータ

id
string
必須

ワークスペースの UUID または slug です。

ボディ

application/json
user_ids
string[]
必須
Required array length: 1 - 100 elements
role
enum<string>
利用可能なオプション:
admin,
member

レスポンス

メンバーを追加しました

added_count
integer
必須
必須範囲: x >= 0
approved
string[]
必須

このリクエストで追加されたユーザー(承認された順)。

failed
object[]
必須

承認に失敗したユーザーとその理由。以降のユーザーは試行されません。

not_attempted
string[]
必須

前の承認が失敗したため試行されなかったユーザー。参加リクエストは保留中のままです。

error
string
message
string
data
object[]

追加されたメンバーの詳細。承認後に読み取れなかった場合は省略されます。その場合も approved に追加されたユーザーが含まれます。

最終更新日 2026年11月16日