personalizer.io Documentation

Help Page Home

POST v1/UserAuthentication

Get user Context ID.

Request Information

URI Parameters

None.

Body Parameters

User authentication parameters.

AuthenticationParams
NameTypeDescriptionComments
SubscriberKey string

SubscriberSourceIdentifier string

IntegrationPartyGuid globally unique identifier

ContextID string

UserID integer

UserIdentifier string

UserEmailAddress string

UserFirstName string

UserLastName string

UserCellPhone string

ContainerGuid globally unique identifier

Request Formats

application/json, text/json

Sample:
{
  "SubscriberKey": "e120-315e2f2-40eb",
  "UserIdentifier": "@JonSnow",
  "UserEmailAddress": "jonsnow@castleblack.com",
  "UserFirstName": "Jon",
  "UserLastName": "Snow",
  "UserCellPhone": "2005667669",
  "BypassExperienceCache": false
}

Response Information

Resource Description

Details for the newly authenticated user Context

AuthenticationResult
NameTypeDescriptionComments
ContextID string

ContextID to be used for making API calls. This must be used on REST HTTP Header value for X-Personalizer-Context-ID

UserID integer

LimeSpot UserID for the Context. This must be included on future authentication requests to ensure user history is incorporated in personalization

Response Formats

application/json, text/json

Sample:
{
  "ContextID": "VAz6MjWE90yadCfQdENsQA",
  "ContextExpirationTimeStamp": 0
}