DELETE /api/v1/forward/channels/{channel_id}
不要になった Channel を削除します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | チャネル ID。Channel オブジェクトの id と同じ値です。 |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
id | string | 削除された Channel ID。 |
deleted | boolean | 削除が成功したかどうか。成功時は常に true。 |
Deletion rules
- 削除後、Channel は受信メッセージを処理せず、QR バインディングを継続できず、チャネル返信を送信できなくなります。
- 削除は取り消せません。受信処理を一時的に停止するには、Update Channel で
enabled=falseを使用してください。
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | - | PAT が無効、期限切れ、または欠落しています。 |
| 404 | not_found_error | - | Channel が存在しないか、呼び出し元から参照できません。 |
| 502 | api_error | - | Channel の削除に失敗しました。 |