POST marketing/v1/UserAuthentication
Get user Context ID.
Request Information
URI Parameters
None.
Body Parameters
User authentication parameters.
AuthenticationParamsName | Type | Description | Comments |
---|---|---|---|
ApiKey | string | ||
SubscriberSourceIdentifier | string | ||
IntegrationPartyGuid | globally unique identifier | ||
ContextID | string | ||
UserID | integer | ||
AlternateUserID | integer | ||
UserIdentifier | string | ||
UserEmailAddress | string | ||
UserCellPhone | string | ||
UserFirstName | string | ||
UserLastName | string | ||
CampaignGuid | globally unique identifier | ||
ContainerGuid | globally unique identifier |
Request Formats
application/json, text/json
Sample:
{ "SubscriberKey": "e120-315e2f2-40eb", "UserIdentifier": "@JonSnow", "UserEmailAddress": "jonsnow@castleblack.com", "UserCellPhone": "2005667669", "UserFirstName": "Jon", "UserLastName": "Snow", "BypassExperienceCache": false }
Response Information
Resource Description
Details for the newly authenticated user Context
AuthenticationResultName | Type | Description | Comments |
---|---|---|---|
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 |
|
UserSegmentGuids | Collection of globally unique identifier |
Response Formats
application/json, text/json
Sample:
{ "ContextID": "VAz6MjWE90yadCfQdENsQA", "ContextExpirationTimeStamp": 0 }