category_delete
カスタムカテゴリを削除するためのエンドポイントです。
なお、削除するカスタムカテゴリに属するホスト、ユーザが多数存在する場合はカテゴリ削除に時間がかかるため、予めホスト、ユーザを削除した上で実行することを推奨します。
| エンドポイント | category_delete |
| 機能 | カテゴリ削除 |
| 実装バージョン | 2.8.0 |
| 認証 | 有り |
| HTTPメソッド | GET/POST |
パラメータ
| 入力値 | 機能 | 入力値の型 | デフォルト値 |
|---|---|---|---|
| q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし |
| q[id] | 削除したいカテゴリのIDを指定します。 | Number | なし |
レスポンス
レスポンス例
{
"success": true,
"response": {}
}