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

招待コード登録

新規ユーザーの登録を行います。

基本仕様​

  • エンドポイント : /user-invitations
  • メソッド : POST

リクエストヘッダー​

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

パスパラメータ​

なし

クエリパラメータ​

なし

リクエストボディ​

パラメータ名タイプ必須説明
count_limit数値必須残登録可能数
creator文字列必須コード作成ユーザーID

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

{
    "count_limit": 20,
    "creator": "admin"
}

レスポンスボディ​

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

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

{
    "invitation_code": "EhaO8C5X",
    "usage_count": 0,
    "count_limit": 20,
    "time_limit": "2023-07-09 15:30:42",
    "creator": "admin"
}