Sign in

Post API v1 user

Changed on
post/api/v1/user

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

biostring

The bio of a user

collegestring

The college of a user

divisioninteger

The division of their college

emailstring required

The email of a user

expected_grad_yearinteger

The user's grad year

first_namestring required

The first name of a user

last_namestring required

The last name of a user

sportstring

The sport(s) the user is interested in

usernamestring required

The username of a user

verified_athlete_statusstring required

Verification status for the athlete

Example request

{
  "$schema": "https://example.com/schemas/CreateUserBody.json",
  "bio": "My name is Suli and I'm a pro athlete",
  "division": 1,
  "email": "suli123@email.com",
  "expected_grad_year": 2027,
  "first_name": "Suli",
  "last_name": "Suli",
  "sport": "[\"hockey\",\"soccer\"]",
  "username": "suliproathlete",
  "verified_athlete_status": "pending"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

idstring required

ID of the user

namestring required

Name of the user

Example response

{
  "$schema": "https://example.com/schemas/CreateUserResponse.json",
  "id": "1",
  "name": "Joe",
  "role": {
    "id": "1",
    "name": "user"
  }
}

Changes