Update a team
PATCH/v1/teams/{teamId}
const url = 'https://api.ligr.live/rest/v1/teams/1';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","gfxName":"example","gfxFullName":"example","abbreviation":"example","age":"Adults","gender":"Male","gradeId":1,"defaultVenueId":1,"primaryBackgroundColor":"example","primaryTextColor":"example","secondaryBackgroundColor":"example","secondaryTextColor":"example","nonPlayerStaff":[{"firstName":"example","lastName":"example","role":"manager"}],"kits":{"home":{"primaryColor":"example","secondaryColor":"example"},"away":{"primaryColor":"example","secondaryColor":"example"},"alt":{"primaryColor":"example","secondaryColor":"example"},"alt2":{"primaryColor":"example","secondaryColor":"example"}}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.ligr.live/rest/v1/teams/1 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "gfxName": "example", "gfxFullName": "example", "abbreviation": "example", "age": "Adults", "gender": "Male", "gradeId": 1, "defaultVenueId": 1, "primaryBackgroundColor": "example", "primaryTextColor": "example", "secondaryBackgroundColor": "example", "secondaryTextColor": "example", "nonPlayerStaff": [ { "firstName": "example", "lastName": "example", "role": "manager" } ], "kits": { "home": { "primaryColor": "example", "secondaryColor": "example" }, "away": { "primaryColor": "example", "secondaryColor": "example" }, "alt": { "primaryColor": "example", "secondaryColor": "example" }, "alt2": { "primaryColor": "example", "secondaryColor": "example" } } }'Changes one or more fields of a team in your organization. Send only the fields to change. Fields that you omit keep their current value. The default venue must belong to your organization. The response has the same shape as GET /v1/teams/{teamId}.
If a data provider supplies the team, the response includes dataProvider.
Your organization has its own copy of a provider team, so an edit changes only your organization.
A provider sync keeps all fields that this route sets. The sync changes only the shared provider record.
One exception: when an admin connects SPORT_RADAR_FOOTBALL to your organization,
the initial load replaces nonPlayerStaff with the provider manager.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity identifier
The team id
Request Bodyrequired
Section titled “Request Bodyrequired”Change one or more fields of a team. Send only the fields to change. Fields that you omit keep their current value.
object
Default Entity name
Name predominantly display in graphics
Name predominantly display in graphics
Abbreviation
Entity identifier
Entity identifier
Replaces the whole staff list. Send an empty array to remove all staff.
Graphics show the manager entry as the coach. If no entry has the manager role, graphics show the first entry.
A coach or other staff member of a team.
object
Role of a team staff member. Graphics show the manager as the coach.
Sets the kit colours per kit. Kits that you omit keep their current colours.
Send null for a kit to remove it. The match picks one kit per team, for example home or away.
Graphics read the selected kit as kit in the match data.
object
object
object
object
object
Responses
Section titled “Responses”Ok
object
Entity identifier
Default Entity name
Name predominantly display in graphics
Name predominantly display in graphics
Abbreviation
Entity identifier
Entity identifier
CDN URL of the team logo, or of the club logo when the team has none. Present only on the team routes.
Coaches and other staff who are not players. Graphics show the manager entry as the coach.
If no entry has the manager role, graphics show the first entry.
A coach or other staff member of a team.
object
Role of a team staff member. Graphics show the manager as the coach.
object
The kit colours of the team, per kit. A kit that the team does not set comes from its club.
A kit that neither sets is absent. Present only on GET, PATCH and the logo routes of
/v1/teams/{teamId}. A match picks one kit per team with homeTeamKitKey and awayTeamKitKey.
object
The two colours of one kit, as hex strings.
object
The two colours of one kit, as hex strings.
object
The two colours of one kit, as hex strings.
object
The two colours of one kit, as hex strings.
object
Example
{ "sport": "football", "nonPlayerStaff": [ { "role": "manager" } ], "dataProvider": { "name": "RB" }}Request is invalid
object
object
Examplegenerated
{ "message": "example", "details": { "additionalProperty": "example" }}Missing or invalid api key
object
Examplegenerated
{ "message": "example"}Api key provides insufficient access for the request
object
Examplegenerated
{ "message": "example"}Team not found
object
Examplegenerated
{ "message": "example"}Organization has made too many requests
object
Examplegenerated
{ "message": "example"}An unexpected error has occured. If problems persist please contact support
object
Examplegenerated
{ "message": "example"}