Documentation

CancelAllServerBackfillTicketsForPlayer

Cancel all active backfill tickets the player is a member of in a given queue.

Attention, this is a flagged API

Beta
This API is under development; Please let us know if you find any bugs or inconsistencies. Also note, that minor changes may occur before this API leaves beta.

Please let us know if you find any issues or inconsistencies.

Request Details

Cancels all backfill tickets of which the player is a member in a given queue that are not cancelled or matched. This API is useful if you lose track of what tickets the player is a member of (if the server crashes for instance) and want to "reset".

CancelAllServerBackfillTicketsForPlayerRequest
Request Properties
Entity (required) EntityKey

The entity key of the player whose backfill tickets should be canceled.

QueueName (required) String

The name of the queue from which a player's backfill tickets should be canceled.

POST https://{{TitleID}}.playfabapi.com/Match/CancelAllServerBackfillTicketsForPlayer
    Content-Type: application/json
{
  "Entity": {
    "Id": "123123123",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  },
  "QueueName": "custom123"
}
        

Response Details

CancelAllServerBackfillTicketsForPlayerResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {}
}

Authentication

EntityToken

Possible Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingUnauthorized 2056