Registrations

>>>

GET /api/v4/users/validate
Registration form validation. DEPRECATED

Success response body ↑

{
  "success": true
}

Status 422 error message ↑

{
  "message": {
    "email": [
        "has already been taken"
    ]
  }
}

Errors

Code Description
unprocessable_entity

Params

Param name Description
email
required

Unique email

Validations:

  • Must be a String
>>>

POST /api/v4/users/sign_up
Registration new user

Success response body ↑

{
  "auth_token": "TOKEN",
}

Status 400 error message ↑

{
  "message": "MESSAGE"
}

Status 422 error message ↑

{
  "message": {
    "email": [
        "has already been taken"
    ]
  }
}

Errors

Code Description
bad_request
unprocessable_entity

Params

Param name Description
user
required

Validations:

  • Must be a Hash
user[email]
required

Unique email

Validations:

  • Must be a String
user[password]
required

Password

Validations:

  • Must be a String
user[first_name]
required

First Name

Validations:

  • Must be a String
user[last_name]
required

Last Name

Validations:

  • Must be a String
user[organization_name]
required

Organization name

Validations:

  • Must be a String
user[organization_type]
required

Organization type

Validations:

  • Must be one of: Public High School, Private High School, College/University, Club/Youth Sports, Other/Not Listed.
user[custom_organization_type]
optional

Custom organization type if organization_type is “Club/Youth Sports”

Validations:

  • Must be a String
user[how_did_you_know_about_us]
required

Option from select how_did_you_know_about_us

Validations:

  • Must be a String
user[utm_source]
optional

Validations:

  • Must be a String
user[utm_medium]
optional

Validations:

  • Must be a String
user[utm_campaign]
optional

Validations:

  • Must be a String
user[utm_term]
optional

Validations:

  • Must be a String
user[utm_content]
optional

Validations:

  • Must be a String
user[query]
optional

Validations:

  • Must be a String
user[plan_interest]
optional

This property indicates what plan the prospect attempted to purchase when they abandoned their cart

Validations:

  • Must be a String
user[platform_plan]
optional

Validations:

  • Must be a String
user[abandoned_cart_date]
optional

This is the date the contact exited the paid flow prior to completing payment.

Validations:

  • Must be a Date
user[purchase_date]
optional

This is the date the user purchases a paid plan

Validations:

  • Must be a Date
user[po_request_date]
optional

The date the user requests a PO invoice

Validations:

  • Must be a Date
user[mobileorweb]
optional

The user device from sign up (user creates an account on desktop - web, user creates an account on mobile - mobile)

Validations:

  • Must be one of: web, mobile.
user[organization_role]
optional

Validations:

  • Must be one of: Athletic Director/Assistant Athletic Director, Activities Director/Assistant Activities Director, Coach, Principal, Student, Other/Not Listed, SID, Principal/President, Marketing/Comms, Other Administrator, Athletic Director, Graphic Designer, Social Media Manager, Club Director/President, Parent, Player, Manager/Other Administrator.
user[custom_organization_role]
optional

Validations:

  • Must be a String
user[how_are_you_hoping_to_use_gipper]
optional

Validations:

  • Must be an array of String
subscription
optional

Validations:

  • Must be a Hash
subscription[plan_id]
required

ID of plan

Validations:

  • Must be a Integer
subscription[token]
required

Stripe token

Validations:

  • Must be a String
subscription[coupon_id]
optional

Coupon

Validations:

  • Must be a Integer
>>>

PUT /api/v4/users/sign_up_invited_user
Registration invited user

Success response body ↑

{
  "auth_token": "TOKEN"
}

Status 400 error message ↑

{
  "message": "MESSAGE"
}

Status 422 error message ↑

{
  "message": {
    "email": [
        "has already been taken"
    ]
  }
}

Params

Param name Description
captcha_token
required

Validations:

  • Must be a String
user_email
required

Email of invited user

Validations:

  • Must be a String
invite_id
required

ID of User invite

Validations:

  • Must be a Integer
user
required

Validations:

  • Must be a Hash
user[email]
required

Unique email

Validations:

  • Must be a String
user[password]
required

Password

Validations:

  • Must be a String
user[first_name]
required

First Name

Validations:

  • Must be a String
user[last_name]
required

Last Name

Validations:

  • Must be a String
user[organization_role]
optional

Validations:

  • Must be one of: Athletic Director/Assistant Athletic Director, Activities Director/Assistant Activities Director, Coach, Principal, Student, Other/Not Listed, SID, Principal/President, Marketing/Comms, Other Administrator, Athletic Director, Graphic Designer, Social Media Manager, Club Director/President, Parent, Player, Manager/Other Administrator.
user[custom_organization_role]
optional

Validations:

  • Must be a String