Account Management - Link Nintendo Switch Device Id

Links the NintendoSwitchDeviceId to the user's PlayFab account

POST https://titleId.playfabapi.com/Client/LinkNintendoSwitchDeviceId

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Name	Required	Type	Description
NintendoSwitchDeviceId	True	string	Nintendo Switch unique identifier for the user's device.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceLink		boolean	If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link.

Name	Type	Description
200 OK	LinkNintendoSwitchDeviceIdResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
LinkNintendoSwitchDeviceIdRequest
LinkNintendoSwitchDeviceIdResult

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

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceLink	boolean	If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link.
NintendoSwitchDeviceId	string	Nintendo Switch unique identifier for the user's device.

Name	Code
LinkedIdentifierAlreadyClaimed	1184