Update a team

PATCH

/v1/teams/{teamId}

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" } ] }'

• LIGR REST API

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

• bearer
  teams:write
• api_key
  teams:write

Parameters

Path Parameters

teamId

required

Entity identifier

integer format: int32

>= 1

The team id

Request Body^required

Media typeapplication/json

Change one or more fields of a team. Send only the fields to change. Fields that you omit keep their current value. Discover grade identifiers with GET /v1/competitions/grades.

object

name

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

Name predominantly display in graphics

string

>= 6 characters <= 19 characters

gfxFullName

Name predominantly display in graphics

string

>= 6 characters <= 35 characters

abbreviation

Abbreviation

string

>= 2 characters <= 4 characters

age

string

Allowed values: Adults U7 U8 U9 U10 U11 U12 U13 U14 U15 U16 U17 U18 U19 U20 U21 U22 U23 Senior Unknown

gender

string

Allowed values: Male Female Mixed Unknown

gradeId

Entity identifier

integer format: int32

>= 1

defaultVenueId

Entity identifier

integer format: int32

>= 1

primaryBackgroundColor

string

primaryTextColor

string

secondaryBackgroundColor

string

secondaryTextColor

string

nonPlayerStaff

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.

Array<object>

A coach or other staff member of a team.

object

firstName

required

string

lastName

required

string

role

required

Role of a team staff member. Graphics show the manager as the coach.

string

Allowed values: manager assistantManager

Responses

200

Ok

Media typeapplication/json

object

id

required

Entity identifier

integer format: int32

>= 1

name

required

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

Name predominantly display in graphics

string

>= 6 characters <= 19 characters

gfxFullName

Name predominantly display in graphics

string

>= 6 characters <= 35 characters

abbreviation

Abbreviation

string

>= 2 characters <= 4 characters

primaryBackgroundColor

string

primaryTextColor

string

secondaryBackgroundColor

string

secondaryTextColor

string

defaultVenueId

Entity identifier

integer format: int32

>= 1

sport

required

string

Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis

clubId

Entity identifier

integer format: int32

>= 1

isHome

boolean

logoUrl

CDN URL of the team logo, or of the club logo when the team has none. Present only on the team routes.

string

nonPlayerStaff

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.

Array<object>

A coach or other staff member of a team.

object

firstName

required

string

lastName

required

string

role

required

Role of a team staff member. Graphics show the manager as the coach.

string

Allowed values: manager assistantManager

dataProvider

object

name

required

string

Allowed values: RB OPTA_CRICKET OPTA_FOOTBALL OPTA_RUGBY_UNION STATSLLC GENIUS_BASKETBALL GENIUS_GRIDIRON GENIUS_VOLLEYBALL GENIUS_FOOTBALL GENIUS_ICE_HOCKEY PIXELLOT CLOUDMIX CHAMPION ligr-live-score MLB IMG_FOOTBALL CRIONET_TENNIS SPORT_RADAR_FOOTBALL

id

required

string

Example

{
  "sport": "football",
  "nonPlayerStaff": [
    {
      "role": "manager"
    }
  ],
  "dataProvider": {
    "name": "RB"
  }
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Team not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}