Overview

Sections

Theme switcher

Register by Device

Header Parameters

Authorizationstring Required

HMAC authentication

Body Parameters

DeviceTypestring

Specific model or variant of the device

DisplayNamestring

User-defined name for the device, used for display purposes

UniqueIdstring

Globally unique identifier assigned to the device

DeviceOSstring

Operating system running on the device

LastOSVersionstring

Version of the device's operating system during its last activity

LastAppVersionstring

Version of the application installed on the device during its last activity

Passwordstring

Password associated with the user account

Countrystring Required

Country where the device is primarily used or registered (eg. US, ES)

Languagestring

Preferred language setting of the device or user (eg. en, es)

DeviceManufacturerstring

Name of the company that produced the device

ApplicationIdinteger

Identifier for the application registering the device

TimezoneOffsetnumber

Device's time zone offset from UTC in minutes

Carrierstring

Mobile network operator associated with the device

Descriptionstring

Additional details or notes about the device

LoginTypestring

Method used by the user to authenticate (e.g., email, social login)

Enum values:
DeviceUsernameFacebookTwitterGoogleMsisdnDeedoPacemakerAppleSony
... 8 other enums
DeviceCategorystring

Classification of the device based on its primary function or type

Enum values:
MobileTVWearable

Response

200
Object

OK

Response Attributes

UserIdinteger

Id of the user

GroupIdstring

The Id of the group which user belongs to

DisplayNamestring

Publicly visible display name for the user

FirstNamestring

First name

LastNamestring

Last name

PrimaryEmailstring

Main email address for the user

PhoneNumberstring

Phone Number for the user

Countrystring

Users home country

Languagestring

Language preference for this user

Circlestring

User's social or organizational circle affiliation

BirthYearinteger

Birth year

Genderstring

User's gender identity

Enum values:
FemaleMale
Subscriptionsarray

List of this users subscriptions to the service

Show child attributes

IsVerifiedboolean

Boolean to see if user is verified or not

ContentKeystring

Content Key

AudioQualitystring

User's preferred audio quality setting for playback

Enum values:
lowhighhlsflacogg
IsPrimaryEmailValidatedboolean

Is primary email validated?

Imagestring

URL to a profile image for the user

BackgroundImagestring

URL to a background image for the user's profile page

Followersarray

List of user id's of other users following this user

Show child attributes

Followingarray

List of user id's of other users this user is following

Show child attributes

IsPublicboolean

Is this user visible to other users?

IsEnabledboolean

Is this user active?

OptedInboolean

Indicates whether the user has opted in to marketing or communications

Blockedarray

List of user ids this user has blocked

Show child attributes

HadTrialboolean

Indicate if the user has ever been on a free trial before

Devicesarray

Devices this user currently has registered

Show child attributes

IsSubProfileboolean

Indicate if the user is a profile.

PrimaryUserIdinteger

The primary user ID if the user is a profile, otherwise it's NULL.

Actionstring

Specifies the action performed or required for the user registration process

Loginsarray

Total number of times the user has logged into their account

Show child attributes

ContentLanguagesarray

List of language codes representing the user's preferred content languages

Show child attributes

UserCentricsControllerIDstring

User Centrics Controller ID

ExternalIdstring

External ID of the user

400
Object

Registration failed

401
Object

HMAC authentication failed

Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?