Skip to main content
POST
/
channels
/
{channel_id}
/
invitation
Error
A valid request URL is required to generate request examples
[
  {
    "id": "<string>",
    "display_name": "<string>",
    "role": "Admin",
    "icon_url": "<string>",
    "metadata": {}
  }
]

Authorizations

​
Authorization
string
header
required

ユーザーがログインすると発行されるsession_idをBearerトークンとして指定します

Path Parameters

​
channel_id
string
required

ユーザーを招待するチャンネルID

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

チャンネルへユーザーを招待するリクエスト

​
user_ids
string[]
required

招待するユーザーIDの配列（最低1件以上必要）

Minimum array length: 1

Response

ユーザーを招待しました

​
id
string
required

ユーザーの一意な識別子

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$
​
display_name
string
required

ユーザーの表示名

Required string length: 1 - 200
​
role
enum<string>
required

ユーザーの権限・役割(Admin:管理者, Member:一般ユーザー)

Available options:
Admin,
Member
​
icon_url
string | null

ユーザーアイコンのURL

​
metadata
object

任意の追加メタデータ