Push User Profile


Request Details

Item Value
Description Sends a user’s profile every time it’s updated to a client specified endpoint.
Method POST
Endpoint Client provided, must begin with https://

 
 
Third Party ID Synchronization Option

An optional feature for the User Profile Data Push is to capture a third_party_id from the Client provided end point API response. The third_party_id value will be stored for the user in CrowdTwist. Note: third_party_id is a client generated user id value, typically generated by a CRM.

If this option is enabled the third_party_id value is required in the API response.

For example:

"third_party_id":123456789,
"third_party_id": “123456789”,

If this option is not enabled, the third_party_id will not be captured & stored with the user record at CrowdTwist.
 

Request Body

Field Name Sample Value Required Format Description
firstName String
middleName String
lastName String
dateOfBirth String
emailAddress String
streetAddress1 String
streetAddress2 String
city String
state String
postalCode String
country String
region String
gender String
emailIsVerified Interger
receiveEmailUpdates Interger
receiveSmsMessages Interger
totalPoints Interger
redeemablePoints Interger
fanRank Interger
mobilePhoneNumber String
dateMobileVerified String
dateLastLogin String
dateLastUpdated String
dateCreated String
signUpTypeId Interger
isActive Interger
userName String
password String
hashAlgorithmId Interger
salt String
passwordGenerated String
activityStreamOptIn Interger
ipAddress String
id long CrowdTwist unique ID for the user
thirdPartyId String
clientBrandingId Interger
facebookUserId String
fsqUserId String
googleUserId String
instUserId String
numFacebookFriends Interger
numPointsPurchased Interger
numTwitterFollowers Interger
signUpCampaign String
twitterUserId String
yahooUserId String
weeklyPoints Interger
monthlyPoints Interger
fanLevelName String
langPref String
customData Object Attribute Names:
employee_id
cashier_id
register_id
store_loc
plcc
cardholder_status
tier – used for client defined tiers only
user_operation
subscriber_type
signUpChannelId String Value to indicate where user registration occurred.
1 = In Store
2 = Online
3 = Kiosk / In Store Other
4 = Call Center
5 = Mobile App
6 = Other


Sample Request

{
  "country": "US",
  "receiveSmsMessages": 0,
  "facebookUserId": 0,
  "redeemablePoints": 100,
  "postalCode": "10010",
  "signUpTypeId": 1,
  "isActive": 1,
  "emailAddress": "test@crowdtwist.com",
  "password": "$TU9xYXQ/H5MG.",
  "yahooUserId": 0,
  "state": "NY",
  "id": "1234567890",
  "monthlyPoints": 0,
  "fanRank": 0,
  "firstName": "Jennie",
  "fsqUserId": 0,
  "activityStreamOptIn": 1,
  "googleUserId": 0,
  "region": "Northeast",
  "instUserId": 0,
  "weeklyPoints": 0,
  "lastName": "Lewis",
  "clientBrandingId": 0,
  "city": "Brooklyn",
  "dateLastUpdated": "1473963548",
  "hashAlgorithmId": 5,
  "numFacebookFriends": 0,
  "dateCreated": "1473963548",
  "numTwitterFollowers": 0,
  "emailIsVerified": 1,
  "fanLevelName": "Silver",
  "dateOfBirth": "179913600",
  "receiveEmailUpdates": 1,
  "userName": "testuser1",
  "totalPoints": 100,
  "numPointsPurchased": 0,
  "customdata": null,
  "passwordGenerated": "1"
}
{
  "country": "US",
  "receiveSmsMessages": 0,
  "facebookUserId": 0,
  "redeemablePoints": 100,
  "postalCode": "10010",
  "signUpTypeId": 1,
  "isActive": 1,
  "emailAddress": "test@crowdtwist.com",
  "password": "$TU9xYXQ/H5MG.",
  "yahooUserId": 0,
  "state": "NY",
  "id": "1234567890",
  "monthlyPoints": 0,
  "fanRank": 0,
  "firstName": "Jennie",
  "fsqUserId": 0,
  "activityStreamOptIn": 1,
  "googleUserId": 0,
  "region": "Northeast",
  "instUserId": 0,
  "weeklyPoints": 0,
  "lastName": "Lewis",
  "clientBrandingId": 0,
  "city": "Brooklyn",
  "dateLastUpdated": "1473963548",
  "hashAlgorithmId": 5,
  "numFacebookFriends": 0,
  "dateCreated": "1473963548",
  "numTwitterFollowers": 0,
  "emailIsVerified": 1,
  "fanLevelName": "Silver",
  "dateOfBirth": "179913600",
  "receiveEmailUpdates": 1,
  "userName": "testuser1",
  "totalPoints": 100,
  "numPointsPurchased": 0,
  "customdata": null,
  "passwordGenerated": "1"
}

Sample Request – Custom Attributes
If custom_data attributes are stored for the user, the object in the data push will include these attributes instead of being null.

"customData":"
  {
    "employee_id": "employee1",
    "register_id": "1",
    "cashier_id": "2"
  }
"customData":"
	{
	  "employee_id": "employee1",
	  "register_id": "1",
	  "cashier_id": "2"
	}