Skip to main content
POST
/
athletes
/
{athleteId}
Update Athlete in Organization
curl --request POST \
  --url https://api.uplift.ai/v1/athletes/{athleteId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "<string>",
  "email": "<string>",
  "height": 123,
  "weight": 123,
  "positions": [
    "<string>"
  ],
  "custom_attributes": {}
}
'
{
  "athlete": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "positions": [
      "<string>"
    ],
    "height": 123,
    "weight": 123,
    "custom_attributes": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

​
Attribute Modification

All attributes of the athlete can be updated. The following rules apply:
  • String Attributes:
    • String values can be updated to any non-empty string.
    • String values can also be set to an empty string ("") to clear the attribute.
  • Integer Attributes:
    • Integer values can be updated to any valid integer.
    • Integer values can also be set to 0 to clear the attribute.
  • Special Rules for first_name:
    • The first_name attribute, if included, cannot be empty. It must always contain a non-empty string.
  • Custom Attributes (custom_attributes):
    • Existing custom attributes follow the same update rules as string and integer attributes.
      • If an existing custom attribute is updated with an empty string ("") or 0, the attribute will be deleted from the custom_attributes object.
    • Users can add new custom attributes during the update. New attributes must follow the same rules as described in the createAthlete endpoint.

​
Example Request

POST /athletes/12345

{
  "last_name": "",
  "email": "john@example.com",
  "weight": 0,
  "custom_attributes": {
    "team": "Team B",
    "position": "pitcher",
    "sport": "MLB"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
athleteId
string
required

The unique identifier for the athlete record to be retrieved.

Body

application/json
​
first_name
string

The first name of the athlete.

Note: This is the minimum required field.

​
last_name
string

The last name of the athlete.

​
date_of_birth
string

The date of birth of the athlete, formatted as YYYY-MM-DD

​
email
string

The athlete's email address.

​
height
integer

The height of the athlete, in inches.

​
weight
integer

The weight of the athlete, in pounds (lbs).

​
dominant_arm
enum<string>

Dominant arm. Allowed values: left, right, both.

Available options:
left,
right,
both
​
dominant_leg
enum<string>

Dominant leg. Allowed values: left, right, both.

Available options:
left,
right,
both
​
activity
enum<string>

Primary sport or activity. Allowed values: baseball, softball, tennis, basketball, golf.

Available options:
baseball,
softball,
tennis,
basketball,
golf
​
positions
string[]

Positions for the athlete's activity. Requires activity to be set. baseball/softball: pitcher, catcher, first_base, second_base, third_base, shortstop, left_field, center_field, right_field, designated_hitter. basketball: point_guard, shooting_guard, small_forward, power_forward, center.

​
competition_level
enum<string>

Competition level. Allowed values: youth, high_school, college, professional.

Available options:
youth,
high_school,
college,
professional
​
custom_attributes
object

A set of custom key-value attributes. Keys must be strings, and values must also be strings.

Response

Athlete updated successfully.

​
athlete
object