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 Format Description
firstName George String User’s first name
middleName 0 String User’s middle name
lastName Twist String User’s last name
dateOfBirth 142372800 String User’s date of birth
emailAddress george15@crowdtwist.com String User’s email address
streetAddress1 null String User’s street address 1
streetAddress2 null String User’s street address 2
city New York City String User’s city
state NY String User’s state
postalCode 10001 String User’s postal code
country US String User’s country code
region Northeast String User’s region
gender Male String User’s gender
emailIsVerified 1 Integer If a user’s email address has been verified
receiveEmailUpdates 1 Integer If a user is subscribed to receive email updates through CrowdTwist
receiveSmsMessages 0 Integer If a user is subscribed to receive SMS updates through CrowdTwist
totalPoints 5200 Integer Total points of the user
redeemablePoints 5200 Integer Redeemable points of the user
fanRank 0 Integer User’s rank within the program
mobilePhoneNumber 12312312321 String Users mobile number
dateMobileVerified null String If a user’s mobile number has been verified
dateLastLogin 1490290125 String Date the user last logged in
dateLastUpdated 1490302144 String Date the user’s profile was last updated
dateCreated 1490293725 String Date the user was created within the CrowdTwist platform
signUpTypeId 3 Integer Channel ID from where the user joined the program
isActive 1 Integer If the user is active
userName gtwist12 String User’s username
password Test123 String User’s password
hashAlgorithmId 1 Integer Hash algorithm, if used
salt null String Salt algorithm, if used
passwordGenerated 0 String If the user’s password was generated by CrowdTwist
activityStreamOptIn 1 Integer If the user is opted in to see his/her updates in activity stream
ipAddress null String The user’s IP address (if available)
id 6566 long Internal CrowdTwist member user_id
thirdPartyId null String User’s third party ID
clientBrandingId 0 Integer  
facebookUserId null String User’s Facebook user ID
fsqUserId null String User’s Foursquare user ID
googleUserId null String User’s Google user ID
instUserId null String User’s Instagram user ID
numFacebookFriends 0 Integer Number of friends the user has on Facebook
numPointsPurchased 0 Integer  
numTwitterFollowers 0 Integer Number of followers the user has on Twitter
signUpCampaign null String Campaign with which the user joined the program
twitterUserId null String User’s Twitter user ID
yahooUserId null String User’s Yahoo user ID
weeklyPoints 0 Integer Number of points the user has earned this week
monthlyPoints 0 Integer Number of points the user has earned this month
fanLevelName Tier 1 String User’s current tier (this is the same as current_level)
langPref null String Language preference of the user
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"
	}