Matchmaking Admin - Remove Matchmaking Queue

Service:

Multiplayer

API Version:

240426

SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.

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

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	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
QueueName	string	The Id of the matchmaking queue to remove.

Responses

Name	Type	Description
200 OK	RemoveMatchmakingQueueResult
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
RemoveMatchmakingQueueRequest	Deletes the configuration for a queue. This will permanently delete the configuration and players will no longer be able to match in the queue. All outstanding matchmaking tickets will be cancelled.
RemoveMatchmakingQueueResult

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

RemoveMatchmakingQueueRequest

Deletes the configuration for a queue. This will permanently delete the configuration and players will no longer be able to match in the queue. All outstanding matchmaking tickets will be cancelled.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
QueueName	string	The Id of the matchmaking queue to remove.

RemoveMatchmakingQueueResult

Error Codes

Name	Code
MatchmakingQueueNotFound	2016