バインド済みの Channel ペアリングの Identity または Template を変更します。
Channel ペアリングは現在 Beta 機能です。API 定義、レスポンス構造、動作は変更される可能性があります。ドキュメントの更新をご確認ください。
POST /api/v1/forward/channel_pairings/{pairing_id}
バインド済み（active）のレコードの Identity または Template を変更します。未バインドのレコードには Channel のペアリングを使用してください。
リクエストパラメータ
Authorization: Bearer <PAT または SAT> と Content-Type: application/json を使用します。必須のパスパラメータ pairing_id はペアリングレコードの id です。
| ボディパラメータ | 型 | 説明 |
|---|---|---|
identity_id | string | 新しい Identity ID。 |
template_id | string | 新しい Template ID。 |
null、文字列以外の値、制御文字、未知のフィールドはサポートしません。Channel とペアリングスコープは変更できません。scope_display_name はチャネルのメッセージから取得され、手動では変更できません。
リクエスト例
レスポンス
成功すると HTTP 200 OK と更新後のペアリングオブジェクトを返します。構造はペアリングの取得と同じで、status は active のままです。
バインディングの変更後、新しいメッセージは新しい実行設定を使用し、既存のセッションは再利用されなくなります。同じ値を繰り返し送信しても、バインディングは再変更されません。
HTTP エラーコード
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | リクエストパラメータが上記の制約に違反、pairing_id が空白または制御文字を含む、または Channel が pairing モードではない場合。 |
| 401 | authentication_error | PAT または SAT が無効または期限切れの場合。 |
| 403 | permission_error | API の呼び出し権限がない場合。 |
| 404 | not_found_error | 有効なペアリングのバインディング、Channel、Identity、Template が存在しないかアクセス不可、または Channel がアーカイブ済みの場合。 |
| 409 | conflict_error | ペアリング状態の競合、バインディングの同時変更、または対象 Identity が無効化済みの場合。 |