Skip to main content
Channels

Channel のペアリング解除

Channel 会話スコープと Identity のペアリングを解除します。

DELETE /api/v1/forward/channel_pairings/{pairing_id}

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または SAT>

Path parameters

ParameterTypeRequiredDescription
pairing_idstringYesペアリングの一覧ペアリングの取得、または Channel のペアリングで返される id

Example request

curl -s -X DELETE 'https://api.qoder.com/api/v1/forward/channel_pairings/pair_019eabc123' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "id": "pair_019eabc123",
  "deleted": true
}

Response fields

FieldTypeDescription
idstringPairing ID。
deletedbooleanペアリング解除に成功した場合 true

HTTP エラーコード

HTTPType発生条件
400invalid_request_errorpairing_id が空白または制御文字を含む場合、またはペアリングの所属先を確認した際に Channel が pairing モードではない場合。
401authentication_errorPAT または SAT が無効または期限切れの場合。
403permission_errorAPI の呼び出し権限がない場合。
404not_found_errorペアリングの所属先を確認した際に、所属する Channel が存在しない、アーカイブ済み、またはアクセス不可の場合。
409conflict_errorバインディングが同時に変更された場合。

Notes

  • 存在しない、または解除済みのペアリングには 200deleted=true を返します。存在するペアリングではアクセス権限の検証が必要です。
  • 解除すると元のバインディングは無効になります。チャネルのペアリングフローを再度開始すると、新しいペアリングコードを取得できます。

関連 API