Abandon a match

POST

/v2/matches/{matchId}/abandon

curl --request POST \
  --url https://api.ligr.live/rest/v2/matches/1/abandon \
  --header 'Authorization: Bearer <token>'

• LIGR REST API

Set the match’s finished status to abandoned.

Authorizations

• bearer
  matches:write
• api_key
  matches:write

Parameters

Path Parameters

matchId

required

Entity identifier

integer format: int32

>= 1

The match identifier

Responses

200

Ok

Media typeapplication/json

object

id

required

Entity identifier

integer format: int32

>= 1

finishedStatus

required

string

Example^generated

{
  "id": 1,
  "finishedStatus": "example"
}

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

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