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.
- The
-
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 (
""
) or0
, the attribute will be deleted from thecustom_attributes
object.
- If an existing custom attribute is updated with an empty string (
- Users can add new custom attributes during the update. New attributes must follow the same rules as described in the
createAthlete
endpoint.
- Existing custom attributes follow the same update rules as string and integer attributes.
Example Request
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique identifier for the athlete record to be retrieved.
Body
The first name of the athlete.
Note: This is the minimum required field.
The last name of the athlete.
The date of birth of the athlete, formatted as YYYY-MM-DD
The athlete's email address.
The height of the athlete, in inches.
The weight of the athlete, in pounds (lbs).
A set of custom key-value attributes. Keys must be strings, and values must also be strings.
Response
Athlete created successfully.
The details of the updated athlete.