Account Management - Link IOS Device ID

Links the vendor-specific iOS device identifier to the user's PlayFab account

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

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 Required Type Description
DeviceId True
  • string

Vendor-specific iOS identifier for the user's device.

CustomTags
  • object

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

DeviceModel
  • string

Specific model of the user's device.

ForceLink
  • boolean

If another user is already linked to the device, unlink the other user and re-link.

OS
  • string

Specific Operating System version for the user's device.

Responses

Name Type Description
200 OK
400 Bad Request

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

ApiErrorWrapper

The basic wrapper around every failed API response

LinkIOSDeviceIDRequest
LinkIOSDeviceIDResult

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

LinkIOSDeviceIDRequest

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.

DeviceModel
  • string

Specific model of the user's device.

ForceLink
  • boolean

If another user is already linked to the device, unlink the other user and re-link.

OS
  • string

Specific Operating System version for the user's device.

LinkIOSDeviceIDResult

Error Codes

Name Code
LinkedDeviceAlreadyClaimed 1118