メインコンテンツまでスキップ

招待コード更新

既存招待コードの情報の更新を行います。

基本仕様

  • エンドポイント : /user-invitations/{invitation_code}
  • メソッド : PUT

リクエストヘッダー

APIキーなどの共通の設定は「Cracker API概要」を参照してください。

パスパラメータ

パラメータ名タイプ必須説明
invitation_code文字列必須情報の更新を行う招待コードを指定します。

クエリパラメータ

なし

リクエストボディ

パラメータ名タイプ必須説明
count_limit数値必須残登録可能数
usage_count数値必須使用回数

リクエストボディサンプル

{
"count_limit": 17,
"usage_count": 3
}

レスポンスボディ

パラメータ名タイプ説明
invitation_code文字列招待コード
usage_count数値使用回数
count_limit数値残登録可能数
time_limitタイムスタンプ登録可能制限時間 yyyy-MM-dd HH:mm:ss

レスポンスボディサンプル

{
"invitation_code": "gBji8VYr",
"usage_count": 3,
"count_limit": 17,
"time_limit": "2024-04-21 20:12:48"
}