Skip to content

Delete an image template

DELETE/v1/image-templates/{imageTemplateId}

DELETE
/v1/image-templates/{imageTemplateId}
curl --request DELETE \
--url https://api.ligr.live/rest/v1/image-templates/1 \
--header 'Authorization: Bearer <token>'

Deletes an image template. A template that entity images or theme mappings still use is refused with 409, and the body lists that usage. Remove those references first.

imageTemplateId
required

Entity identifier

integer format: int32
>= 1

The image template id

Deleted

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

Image template not found

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

Something still uses the image template

Media typeapplication/json

Body of a 409 answer for a template that is still in use.

code is always IMAGE_TEMPLATE_IN_USE. usage lists what still uses the template.

object
message
required
string
code
required
string
usage
required

Everything that still uses the template. A template in use cannot be deleted.

object
instanceCount
required

Images that players, teams or competitions hold for the template.

number format: double
themeMappings
required
Array<object>

One competition theme setting that binds the template into a graphic.

object
competitionId
required

Entity identifier

integer format: int32
>= 1
competitionName
required
string
themeSettingId
required

Entity identifier

integer format: int32
>= 1
themeSettingName
required
string
themeId
required

Entity identifier

integer format: int32
>= 1
graphicId
required

The graphic the template feeds. Null: not tied to one graphic.

string
nullable
Examplegenerated
{
"message": "example",
"code": "example",
"usage": {
"instanceCount": 1,
"themeMappings": [
{
"competitionId": 1,
"competitionName": "example",
"themeSettingId": 1,
"themeSettingName": "example",
"themeId": 1,
"graphicId": "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"
}