category_update
カスタムカテゴリを更新するためのエンドポイントです。
エンドポイント | category_update |
機能 | カテゴリ更新 |
実装バージョン | 2.8.0 |
認証 | 有り |
HTTPメソッド | GET/POST |
パラメータ
入力値 | 機能 | 入力値の型 | デフォルト値 |
---|---|---|---|
q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし |
q[id] | 更新したいカテゴリの ID を指定します。 | Number | なし |
q[name] | 更新したいカテゴリ名を入力します。 | String | なし |
q[desc] | 更新したいカテゴリの説明文を入力します。 | String | なし |
q[hostlim] |
更新したいホスト登録上限数を指定します。 無制限に設定する場合は、q[hostlim]= のように値を設定しないようにリクエストを生成します。 |
Number | 10 |
レスポンス
レスポンス例
{ "success": true, "response": {} }