Account Management - Unlink Custom ID

Unlinks the related custom identifier from the user's PlayFab account

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

Request Header

Name Required Type Description
SessionTicket True
  • string

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

Request Body

Name Type Description
CustomId
  • string

Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID will be used.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

UnlinkCustomIDRequest
UnlinkCustomIDResult

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

UnlinkCustomIDRequest

Name Type Description
CustomId
  • string

Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID will be used.

UnlinkCustomIDResult

Error Codes

Name Code
AccountNotLinked 1014
CustomIdNotLinked 1185