Account Management - Unlink Custom ID

  • Reference
Service:
Client
API Version:
240412

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

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

Request Header

Name Required Type Description
X-Authorization 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.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

UnlinkCustomIDResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-Authorization

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

Type: apiKey
In: header

Definitions

Name Description
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.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

UnlinkCustomIDResult

Error Codes

Name Code
AccountNotLinked 1014
CustomIdNotLinked 1185