PUT api/Content/v3/Login

Request Information

URI Parameters

None.

Body Parameters

APILogin
NameDescriptionTypeAdditional information
CustomerId

integer

Required

UniqueId

globally unique identifier

None.

Email

string

None.

Password

string

None.

OldPassword

string

None.

ExternalLogin

boolean

None.

UserUniqueId

integer

None.

UserType

string

None.

ExternalLoginType

string

None.

ExternalLoginId

string

None.

AccessToken

string

None.

ExternalProfileURL

string

None.

FirstName

string

None.

LastName

string

None.

Gender

string

None.

NeonMembershipId

integer

None.

OSVersion

string

None.

ModelNumber

string

None.

AppVersion

string

None.

TourDePearlRegId

integer

None.

NeonPaymentStatus

string

None.

NeonAutoRenew

boolean

None.

ExpiryDate

date

None.

ShowLeaderBoardBrewery

boolean

None.

AppType

string

None.

AppName

string

None.

DeviceTokenId

string

None.

DeviceType

string

None.

IsOldApp

boolean

None.

IsMigrated

boolean

None.

IsAutoLogin

boolean

None.

IsImported

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "UniqueId": "f8c7d597-d3ba-4fb8-8797-10fac86af414",
  "Email": "sample string 3",
  "Password": "sample string 4",
  "OldPassword": "sample string 5",
  "ExternalLogin": true,
  "UserUniqueId": 7,
  "UserType": "sample string 8",
  "ExternalLoginType": "sample string 9",
  "ExternalLoginId": "sample string 10",
  "AccessToken": "sample string 11",
  "ExternalProfileURL": "sample string 12",
  "FirstName": "sample string 13",
  "LastName": "sample string 14",
  "Gender": "sample string 15",
  "NeonMembershipId": 16,
  "OSVersion": "sample string 17",
  "ModelNumber": "sample string 18",
  "AppVersion": "sample string 19",
  "TourDePearlRegId": 20,
  "NeonPaymentStatus": "sample string 21",
  "NeonAutoRenew": true,
  "ExpiryDate": "2026-01-15T10:10:15.6466761+00:00",
  "ShowLeaderBoardBrewery": true,
  "AppType": "sample string 25",
  "AppName": "sample string 26",
  "DeviceTokenId": "sample string 27",
  "DeviceType": "sample string 28",
  "IsOldApp": true,
  "IsMigrated": true,
  "IsAutoLogin": true,
  "IsImported": true
}

application/xml, text/xml

Sample:
<APILogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <AccessToken>sample string 11</AccessToken>
  <AppName>sample string 26</AppName>
  <AppType>sample string 25</AppType>
  <AppVersion>sample string 19</AppVersion>
  <CustomerId>1</CustomerId>
  <DeviceTokenId>sample string 27</DeviceTokenId>
  <DeviceType>sample string 28</DeviceType>
  <Email>sample string 3</Email>
  <ExpiryDate>2026-01-15T10:10:15.6466761+00:00</ExpiryDate>
  <ExternalLogin>true</ExternalLogin>
  <ExternalLoginId>sample string 10</ExternalLoginId>
  <ExternalLoginType>sample string 9</ExternalLoginType>
  <ExternalProfileURL>sample string 12</ExternalProfileURL>
  <FirstName>sample string 13</FirstName>
  <Gender>sample string 15</Gender>
  <IsAutoLogin>true</IsAutoLogin>
  <IsImported>true</IsImported>
  <IsMigrated>true</IsMigrated>
  <IsOldApp>true</IsOldApp>
  <LastName>sample string 14</LastName>
  <ModelNumber>sample string 18</ModelNumber>
  <NeonAutoRenew>true</NeonAutoRenew>
  <NeonMembershipId>16</NeonMembershipId>
  <NeonPaymentStatus>sample string 21</NeonPaymentStatus>
  <OSVersion>sample string 17</OSVersion>
  <OldPassword>sample string 5</OldPassword>
  <Password>sample string 4</Password>
  <ShowLeaderBoardBrewery>true</ShowLeaderBoardBrewery>
  <TourDePearlRegId>20</TourDePearlRegId>
  <UniqueId>f8c7d597-d3ba-4fb8-8797-10fac86af414</UniqueId>
  <UserType>sample string 8</UserType>
  <UserUniqueId>7</UserUniqueId>
</APILogin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APILoginReturn
NameDescriptionTypeAdditional information
Status

boolean

None.

Message

string

None.

UserType

string

None.

UserUniqueId

integer

None.

qrLocation

string

None.

FirstName

string

None.

LastName

string

None.

ProfileURL

string

None.

NeonMembershipId

integer

None.

TourDePearlRegId

integer

None.

NeonPaymentStatus

string

None.

NeonAutoRenew

boolean

None.

ExpiryDate

date

None.

ShowLeaderBoardBrewery

boolean

None.

FacebookContactId

integer

None.

GoogleContactId

integer

None.

AppleContactId

integer

None.

FacebookEmail

string

None.

GoogleEmail

string

None.

AppleEmail

string

None.

MembershipId

integer

None.

Token

string

None.

UniqueId

string

None.

IsNewUser

boolean

None.

IsInternalAccount

boolean

None.

Address1

string

None.

Address2

string

None.

Email

string

None.

City

string

None.

State

string

None.

Country

string

None.

ZipCode

string

None.

Phone

string

None.

BirthDay

date

None.

Gender

string

None.

ShowBadge

boolean

None.

FacebookId

string

None.

GoogleId

string

None.

AppleId

string

None.

ExternalUserName

string

None.

ExternalUserNameGoogle

string

None.

ExternalUserNameApple

string

None.

MiddleName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "Message": "sample string 2",
  "UserType": "sample string 3",
  "UserUniqueId": 4,
  "qrLocation": "sample string 5",
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "ProfileURL": "sample string 8",
  "NeonMembershipId": 9,
  "TourDePearlRegId": 10,
  "NeonPaymentStatus": "sample string 11",
  "NeonAutoRenew": true,
  "ExpiryDate": "2026-01-15T10:10:15.6466761+00:00",
  "ShowLeaderBoardBrewery": true,
  "FacebookContactId": 15,
  "GoogleContactId": 16,
  "AppleContactId": 17,
  "FacebookEmail": "sample string 18",
  "GoogleEmail": "sample string 19",
  "AppleEmail": "sample string 20",
  "MembershipId": 21,
  "Token": "sample string 22",
  "UniqueId": "sample string 23",
  "IsNewUser": true,
  "IsInternalAccount": true,
  "Address1": "sample string 25",
  "Address2": "sample string 26",
  "Email": "sample string 27",
  "City": "sample string 28",
  "State": "sample string 29",
  "Country": "sample string 30",
  "ZipCode": "sample string 31",
  "Phone": "sample string 32",
  "BirthDay": "2026-01-15T10:10:15.6466761+00:00",
  "Gender": "sample string 33",
  "ShowBadge": true,
  "FacebookId": "sample string 35",
  "GoogleId": "sample string 36",
  "AppleId": "sample string 37",
  "ExternalUserName": "sample string 38",
  "ExternalUserNameGoogle": "sample string 39",
  "ExternalUserNameApple": "sample string 40",
  "MiddleName": "sample string 41"
}

application/xml, text/xml

Sample:
<APILoginReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Address1>sample string 25</Address1>
  <Address2>sample string 26</Address2>
  <AppleContactId>17</AppleContactId>
  <AppleEmail>sample string 20</AppleEmail>
  <AppleId>sample string 37</AppleId>
  <BirthDay>2026-01-15T10:10:15.6466761+00:00</BirthDay>
  <City>sample string 28</City>
  <Country>sample string 30</Country>
  <Email>sample string 27</Email>
  <ExpiryDate>2026-01-15T10:10:15.6466761+00:00</ExpiryDate>
  <ExternalUserName>sample string 38</ExternalUserName>
  <ExternalUserNameApple>sample string 40</ExternalUserNameApple>
  <ExternalUserNameGoogle>sample string 39</ExternalUserNameGoogle>
  <FacebookContactId>15</FacebookContactId>
  <FacebookEmail>sample string 18</FacebookEmail>
  <FacebookId>sample string 35</FacebookId>
  <FirstName>sample string 6</FirstName>
  <Gender>sample string 33</Gender>
  <GoogleContactId>16</GoogleContactId>
  <GoogleEmail>sample string 19</GoogleEmail>
  <GoogleId>sample string 36</GoogleId>
  <IsInternalAccount>true</IsInternalAccount>
  <IsNewUser>true</IsNewUser>
  <LastName>sample string 7</LastName>
  <MembershipId>21</MembershipId>
  <Message>sample string 2</Message>
  <MiddleName>sample string 41</MiddleName>
  <NeonAutoRenew>true</NeonAutoRenew>
  <NeonMembershipId>9</NeonMembershipId>
  <NeonPaymentStatus>sample string 11</NeonPaymentStatus>
  <Phone>sample string 32</Phone>
  <ProfileURL>sample string 8</ProfileURL>
  <ShowBadge>true</ShowBadge>
  <ShowLeaderBoardBrewery>true</ShowLeaderBoardBrewery>
  <State>sample string 29</State>
  <Status>true</Status>
  <Token>sample string 22</Token>
  <TourDePearlRegId>10</TourDePearlRegId>
  <UniqueId>sample string 23</UniqueId>
  <UserType>sample string 3</UserType>
  <UserUniqueId>4</UserUniqueId>
  <ZipCode>sample string 31</ZipCode>
  <qrLocation>sample string 5</qrLocation>
</APILoginReturn>