Account Management - Unlink IOS Device ID

Unlinks the related iOS device identifier from the user's PlayFab account

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

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
CustomTags

object

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

DeviceId

string

Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will be used.

Responses

Name Type Description
200 OK

UnlinkIOSDeviceIDResult

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

UnlinkIOSDeviceIDRequest
UnlinkIOSDeviceIDResult

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

UnlinkIOSDeviceIDRequest

Name Type Description
CustomTags

object

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

DeviceId

string

Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will be used.

UnlinkIOSDeviceIDResult

Error Codes

Name Code
AccountNotLinked 1014
DeviceNotLinked 1120