Batch Activity Credit

In the event JavaScript tags and our Activity Credit API can’t be used, clients can send a TXT file via SFTP. Activity points will not be rewarded in real time, but rather when the file is uploaded and processed.

Documentation
Sample File Name: activities_[client_id]_yyyymmddhhmiss.txt, where client ID is the client identifying parameter within the CrowdTwist system. Do not include a header row in the file. The file should be pipe delimited. The file should be saved with UTF-8 encoding and without field enclosures.

Required Fields:

At least one of the first 4 listed attributes in the following list are required in addition to the Activity ID. Number of points is not a required field, but will override the default point value of the activity if utilized. We also have the ability to back-date the awarding of activities via the optional ACTIVITY_DATE field.

  • Email – Member’s email address, if not available leave null value
  • CT User ID – CrowdTwist unique user id for a member, if not available leave null value
  • Third Party ID – Client’s unique internal ID for a member, if not available leave null value
  • Username – Member’s username, if not available leave null value
  • Activity ID – CrowdTwist Activity ID, will be provided when activity is created in CT’s system

  • Points – Override for the number of points to award a member for completing the action (ignores configured value in activity settings)

  • Activity Date – The UNIX timestamp of when an activity was completed (optional)

If the points per activity are variable, a sixth column can be added to the batch file:

  • Number of points – number of points to award for this member for this activity.

The placement of data attributes relative to the pipes is as follows:

  EMAIL|CT_USER_ID|THIRD_PARTY_ID|USERNAME|ACTIVITY_ID|POINTS|ACTIVITY_DATE
	EMAIL|CT_USER_ID|THIRD_PARTY_ID|USERNAME|ACTIVITY_ID|POINTS|ACTIVITY_DATE

Notes:

  • The file must include at least one user-identifying field (e.g. email, CT User ID, Third Party ID, Username).
  • For matched identifiable fields, data isprocessed in the following order: CT User ID, Email, Username, Third Party Id.
  • Third Party ID is not a uniquely required field in CrowdTwist, if multiple records are found the first will be awarded.

Example – Standard: 

  testing@crowdtwist.com|||testusername|126456789
  testing2@crowdtwist.com|||testusername2|126456789
	testing@crowdtwist.com|||testusername|126456789
	testing2@crowdtwist.com|||testusername2|126456789

Example – with Number of Points Column: 

  testing@crowdtwist.com|||testusername|126456789|400
  testing2@crowdtwist.com|||testusername2|126456789|550
	testing@crowdtwist.com|||testusername|126456789|400
	testing2@crowdtwist.com|||testusername2|126456789|550

Example – with only Email Address 

  test303@emailaddress.com||||410061376
	test303@emailaddress.com||||410061376

Example – with only CT User ID 

  |54064211|||410061376
	|54064211|||410061376

Example – with CT User ID & Activity Date 

  |54064211|||410061376||1551456336
	|54064211|||410061376||1551456336