Skip to main content
POST
Link IOS Device ID

Authorizations

X-Authorization
string
header
required

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

Body

application/json
DeviceId
string
required

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.

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.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026