Channel の紐づけ、表示名、有効状態、または返信オプションを更新します。
POST /api/v1/forward/channels/{channel_id}
merge-patch セマンティクスを使用します。省略されたフィールドは変更されません。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Content-Type | Yes | application/json |
Idempotency-Key | No | 安全でないリクエスト向けの任意のべき等性キー。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | チャネル ID。 |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | チャネルの表示名。 |
identity_id | string | No | fixed モードでの新しい Forward Identity ID。 |
template_id | string | No | fixed モードでの新しい Forward Template ID。 |
enabled | boolean | No | 手動での有効化・無効化スイッチ。 |
channel_config.response_options | object | No | 返信の表示設定。 |
Example request
Example response
HTTP 200 OK
Response fields
更新後の Channel オブジェクトを返します。
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | リクエストボディが無効です。 |
| 401 | authentication_error | PAT または SAT が無効または期限切れです。 |
| 404 | not_found_error | Channel が存在しません。 |
| 404 | not_found_error | 新しい Template が存在しません。 |
| 404 | not_found_error | 新しい Identity が存在しません。 |
| 409 | conflict_error | 新しい Identity が無効になっています。 |
Notes
identity_resolution.modeは作成後に変更できません。モードを切り替えるには Channel を削除して再作成する必要があります。pairingモードではidentity_idまたはtemplate_idの更新はできません。これらは Pairing API によってメッセージスコープごとにバインドされます。id、type、channel_typeは更新できません。binding_statusはシステムによって維持されます。enabled=trueは手動スイッチを開くだけです。binding_statusは変更されません。fixedモードでidentity_idまたはtemplate_idを更新すると、既存の会話バインディングの再利用が停止する場合があります。新しい受信メッセージは新しいバインディングを使用します。