Matchmaking - Join Matchmaking Ticket

Join a matchmaking ticket.

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

Request Body

Name Required Type Description
Member True

The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith.

QueueName True
  • string

The name of the queue to join.

TicketId True
  • string

The Id of the ticket to find a match for.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

EntityToken

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

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

JoinMatchmakingTicketRequest

Add the player to a matchmaking ticket and specify all of its matchmaking attributes. Players can join a ticket if and only if their EntityKeys are already listed in the ticket's Members list. The matchmaking service automatically starts matching the ticket against other matchmaking tickets once all players have joined the ticket. It is not possible to join a ticket once it has started matching.

JoinMatchmakingTicketResult
MatchmakingPlayer

A user in a matchmaking ticket.

MatchmakingPlayerAttributes

The matchmaking attributes for a user.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

JoinMatchmakingTicketRequest

Add the player to a matchmaking ticket and specify all of its matchmaking attributes. Players can join a ticket if and only if their EntityKeys are already listed in the ticket's Members list. The matchmaking service automatically starts matching the ticket against other matchmaking tickets once all players have joined the ticket. It is not possible to join a ticket once it has started matching.

Name Type Description
Member

The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith.

QueueName
  • string

The name of the queue to join.

TicketId
  • string

The Id of the ticket to find a match for.

JoinMatchmakingTicketResult

MatchmakingPlayer

A user in a matchmaking ticket.

Name Type Description
Attributes

The user's attributes custom to the title.

Entity

The entity key of the matchmaking user.

MatchmakingPlayerAttributes

The matchmaking attributes for a user.

Name Type Description
DataObject
  • object

A data object representing a user's attributes.

EscapedDataObject
  • string

An escaped data object representing a user's attributes.

Error Codes

Name Code
MatchmakingAlreadyJoinedTicket 2028
MatchmakingAttributeInvalid 2046
MatchmakingEntityInvalid 2001
MatchmakingMemberProfileInvalid 2032
MatchmakingPlayerAttributesInvalid 2002
MatchmakingPlayerAttributesTooLarge 2043
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingTicketAlreadyCompleted 2029
MatchmakingTicketMembershipLimitExceeded 2055
MatchmakingTicketNotFound 2018
MatchmakingUnauthorized 2056