03-6417-9339

平日 9:30 ~ 12:00 / 13:00 ~ 17:30

category_add


カスタムカテゴリを新規登録するためのエンドポイントです。

エンドポイント category_add
機能 カテゴリ新規登録
実装バージョン 2.8.0
認証 有り
HTTPメソッド GET/POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。
String なし
q[name] 新規登録したいカテゴリ名を入力します。 String なし
q[desc] 新規登録したいカテゴリの説明文を入力します。 String なし
q[hostlim] ホスト登録上限数を指定します。
無制限に設定する場合は、q[hostlim]= のように値を設定しないようにリクエストを生成します。
Number 10

レスポンス

key value の内容 value の型
success 新規登録の成否 Boolean
response エラー等の補足情報 Hash
id 登録されたカテゴリのカテゴリ ID Number

レスポンス例

{
  "success": true,
  "response": {},
  "id":50
}

サンプルコード (作成中)