Sign in

Patch API v1 user

Changed on
patch/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

The email of a user

expected_grad_yearinteger

The user's grad year

first_namestring

The first name of a user

last_namestring

The last name of a user

profile_picturestring

S3 key for the user's profile picture

sportstring

The sport(s) the user is interested in

usernamestring

The username of a user

verified_athlete_statusstring

Verification status for the athlete

Example request

{
  "$schema": "https://example.com/schemas/UpdateUserBody.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.

biostring

The bio 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

idstring required

ID of the user

last_namestring required

The last name of a user

profile_picturestring

Presigned download URL for the user's profile picture

usernamestring required

The username of a user

verified_athlete_statusstring required

Verification status for the athlete

Example response

{
  "$schema": "https://example.com/schemas/GetUserResponse.json",
  "bio": "My name is Suli and I'm a pro athlete",
  "college": {
    "academic_rank": 53,
    "city": "Boston",
    "division_rank": 1,
    "name": "Northeastern University",
    "state": "Massachusetts",
    "website": "https://www.northeastern.edu"
  },
  "division": 1,
  "email": "suli123@email.com",
  "expected_grad_year": 2027,
  "first_name": "Suli",
  "id": "1",
  "last_name": "Suli",
  "roles": [
    {
      "$schema": "https://example.com/schemas/RoleResponse.json",
      "id": "1",
      "name": "admin",
      "permissions": [
        {
          "$schema": "https://example.com/schemas/PermissionResponse.json",
          "action": "create",
          "id": "1",
          "resource": "user"
        }
      ]
    }
  ],
  "sport": {
    "name": "Women's Soccer",
    "popularity": 20000
  },
  "username": "suliproathlete",
  "verified_athlete_status": "pending"
}

Changes