Skip to contents

Create a new athlete or athletes for an account. Bulk create up to 500 athletes at a time.

Usage

create_athletes(athleteData)

Arguments

athleteData

A data frame of the athletes to be created. The data frame must follow the schema:

Value

If successful, a confirmation message will be printed with the number of successful athletes created. If there are failures, a data frame containing the athletes that failed to be created will be returned with columns:

Column NameTypeDescription
reasonchrReason for failed creation
namechrAthlete's given name (First Last)

Details

The data frame passed as the argument must use the following schema:

Column NameTypeInclusionDescription
namechrREQUIREDathlete's given name (First Last)
imagechroptionalURL path to image. default = null
activelogioptionalathlete is active (TRUE). default = null
teamslistoptionala single team id as a string or list of team ids. default = [defaultTeamId]
groupslistoptionala single group id as a string or list of group ids. default = []
external propertychroptionalExternal properties can be added by adding any additional columns of equal length. The name of the column will become the external property name, and the row value will become the external property value. Use "lowercase" or "snake_case" styles for column names.

Examples