Skip to content

Set the competition primary watermark

PUT/v1/competitions/{competitionId}/watermark

PUT
/v1/competitions/{competitionId}/watermark
curl --request PUT \
--url https://api.ligr.live/rest/v1/competitions/1/watermark \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "uploadId": 1 }'

Sets the competition primary watermark from a completed upload. The API checks the size and SHA-256 of the bytes. Each upload sets an image one time. The response has the same shape as GET /v1/competitions/{competitionId}.

competitionId
required

Entity identifier

integer format: int32
>= 1

The competition id

Media typeapplication/json

Set a competition image from a completed upload.

object
uploadId
required

The uploadId from the POST …/uploads route of the same image.

number format: double
Examplegenerated
{
"uploadId": 1
}

Ok

Media typeapplication/json
object
id
required

Entity identifier

integer format: int32
>= 1
name
required

Default Entity name

string
>= 6 characters <= 39 characters
gfxName
required

Name predominantly display in graphics

string
nullable >= 6 characters <= 19 characters
sport
required
string
Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis
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
logoUrl

CDN URL of the competition logo. Present only on the competition routes.

string
watermarkUrl

CDN URL of the primary watermark. Present only on the competition routes.

string
secondaryWatermarkUrl

CDN URL of the secondary watermark. Present only on the competition routes.

string
matchConfig

The match rules that every match of the competition inherits: the periods, the clock, the data coverage and, for some sports, rules. The shape depends on the sport. A match config overrides these values for one match. Change them with PATCH /v1/competitions/{competitionId}.

Example
{
"id": 24,
"name": "UEFA Champions League",
"gfxName": "Champions League",
"sport": "football",
"matchConfig": {
"startingLineupSize": 11,
"maxBenchSize": 7,
"periods": {
"regular": {
"number": 2,
"name": "Regular",
"length": 45,
"breakLength": 15
}
},
"dataCoverage": {
"stats": "minimum"
}
}
}

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
"message": "example",
"details": {
"additionalProperty": "example"
}
}

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

Competition not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

Organization has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

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

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}