Matchmaking - Unsubscribe From Matchmaking Resource

Service:

Multiplayer

API Version:

240524

Unsubscribe from match resource notifications.

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

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
EntityKey	True	EntityKey	The entity performing the unsubscription. The entity must be authorized to use this connectionHandle.
PubSubConnectionHandle	True	string	Opaque string, given to a client upon creating a connection with PubSub.
ResourceId	True	string	The name of the resource to unsubscribe from. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.
SubscriptionVersion	True	number	Version number for the unsubscription from this resource.
Type	True	string	Type of the subscription to be canceled.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	UnsubscribeFromMatchResourceResult
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
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
UnsubscribeFromMatchResourceRequest	Unsubscribe from a Match resource's notifications. For MatchInvite, players are expected to unsubscribe once they can no longer accept invites. For MatchTicketStatusChange, players are expected to unsusbcribe once the ticket has reached a canceled or matched state.
UnsubscribeFromMatchResourceResult

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

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

UnsubscribeFromMatchResourceRequest

Unsubscribe from a Match resource's notifications. For MatchInvite, players are expected to unsubscribe once they can no longer accept invites. For MatchTicketStatusChange, players are expected to unsusbcribe once the ticket has reached a canceled or matched state.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EntityKey	EntityKey	The entity performing the unsubscription. The entity must be authorized to use this connectionHandle.
PubSubConnectionHandle	string	Opaque string, given to a client upon creating a connection with PubSub.
ResourceId	string	The name of the resource to unsubscribe from. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.
SubscriptionVersion	number	Version number for the unsubscription from this resource.
Type	string	Type of the subscription to be canceled.

UnsubscribeFromMatchResourceResult

Error Codes

Name	Code
MatchmakingAttributeInvalid	2046
MatchmakingBadRequest	2059
MatchmakingEntityInvalid	2001
MatchmakingTicketNotFound	2018
MatchmakingUnauthorized	2056
PubSubConnectionHandleInvalid	2503
PubSubConnectionNotFoundForEntity	2502