Overview

Sections

Theme switcher

Register by Email

Header Parameters

StoreIdstring Required

API Key provided by Tuned Global for accessing the service

Authorizationstring Required

Bearer token

Body Parameters

Otpstring Required

One-time password provided for verification purposes

Passwordstring Required

Password chosen by the user for account authentication

Emailstring Required

User's email address used for registration and login

OptedInboolean

Indicates if the user has consented to GDPR terms

Countrystring

Country code representing the user's location (e.g. ZA, US, AU)

Languagestring Required

Preferred language for user communications and interface (e.g. en, es, az)

BirthYearinteger

User's year of birth in YYYY format

Genderstring

User's gender identity

FirstNamestring

User's given or first name

Surnamestring

User's family name or last name

TimezoneOffsetnumber

User's time zone offset from UTC in hours

Response

201
Object

User is successfully created.

Response Attributes

UserIdstring

The unique identifier of the user

GroupIdstring

The group ID associated with the user

DisplayNamestring

The display name of the user

FirstNamestring

The first name of the user

LastNamestring

The last name of the user

PrimaryEmailstring

The primary email address of the user

PhoneNumberstring

The phone number of the user

Countrystring

The country of the user

Languagestring

The language preference of the user

Circlestring

The circle associated with the user

BirthYearstring

The year of birth of the user

Genderstring

The gender of the user

Subscriptionsobject

The subscriptions associated with the user

IsVerifiedboolean

Flag indicating if the user is verified

ContentKeystring

The content key associated with the user

AudioQualitystring

The audio quality settings for the user

IsPrimaryEmailValidatedboolean

Flag indicating if the primary email of the user is validated

Imagestring

The image associated with the user

BackgroundImagestring

The background image set for the registered user's profile.

Followersobject

The list of followers for the registered user.

Followingobject

The list of users that the registered user follows.

IsPublicboolean

Indicates whether the registered user's profile is public or not.

IsEnabledboolean

Indicates whether the registered user's account is enabled or not.

OptedInboolean

Indicates whether the registered user has opted into GDPR or not.

Blockedobject

The list of users that are blocked by the registered user.

HadTrialboolean

Indicates whether the registered user has had a trial period or not.

Devicesobject

The list of devices owned or used by the registered user.

IsSubProfileboolean

Indicates whether the registered user is a sub-profile or not.

PrimaryUserIdstring

The unique identifier for the primary user associated with the registration.

Actionstring

The action performed during the user registration process.

Loginsobject

The list of login methods associated with this user.

ContentLanguagesobject

The languages in which the registered user consumes content.

UserCentricsControllerIDstring

The unique identifier for the user centrics controller associated with the registered user.

ExternalIdstring

The external identifier associated with the registered user.

400
Object

Failed to create the user account.

401
Object

OTP validation failed.

409
Object

User account with this email already exists.

500
Object

Unexpected error occurred.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?