Matchmaking - Cancel All Matchmaking Tickets For Player

  • Reference
Service:
Multiplayer
API Version:
240412

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

POST https://titleId.playfabapi.com/Match/CancelAllMatchmakingTicketsForPlayer

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Required Type Description
QueueName True

string

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

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity

EntityKey

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

Responses

Name Type Description
200 OK

CancelAllMatchmakingTicketsForPlayerResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
CancelAllMatchmakingTicketsForPlayerRequest

Cancels all 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 title crashes for instance) and want to "reset". The Entity field is optional if the caller is a player and defaults to that player. Players may not cancel tickets for other people. The Entity field is required if the caller is a server (authenticated as the title).
CancelAllMatchmakingTicketsForPlayerResult
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

CancelAllMatchmakingTicketsForPlayerRequest

Cancels all 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 title crashes for instance) and want to "reset". The Entity field is optional if the caller is a player and defaults to that player. Players may not cancel tickets for other people. The Entity field is required if the caller is a server (authenticated as the title).

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity

EntityKey

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

string

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

CancelAllMatchmakingTicketsForPlayerResult

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.
Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingUnauthorized 2056