Documentation

LinkIOSDeviceID

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

Request Details

LinkIOSDeviceIDRequest
Request Properties
DeviceId (required) 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.

POST https://{{TitleID}}.playfabapi.com/Client/LinkIOSDeviceID
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "DeviceId": "29848d9bh8900a0b003",
  "OS": "7.11",
  "DeviceModel": "Iphone 5s"
}
        

Response Details

LinkIOSDeviceIDResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SessionTicket

Possible Error Codes

Name Code
LinkedDeviceAlreadyClaimed 1118