Live Push Points Expiration

Request Details

Item	Value
Description	This endpoint is used to send point expiration details every time it’s updated.
Method	POST
Endpoint	Client provided, must begin with https://
Content Type	application/json

Recommended Request Authentication

Field Name

Sample Value

Required

Format

Description

Basic

Username: test

Password: password123

Base64Auth

String

Basic auth is the client provided username & password in Base 64 format.

The value of username:password is Base64 encoded.

x-api-key

GRscvhg53SsDg1gxxsDgcsf123

String

x-api-key is the client provided API key for access to the defined endpoint.

Request Body

Live push will provide point expiration details for 1 month trailing, current month and 5 month forward months where points are expiring i.e. points data exist.

Field Name	Sample Value	Format	Description
User Details
user_id	348399	Integer	CrowdTwist member id.
email_address	test@ct.com	String	Email of the member.
third_party_id	12322	String	Third party id of the user.
message_date	2021-05-20T18:25:43.511-04:00	String	Event capture timestamp for inactivity point expiration.
Inactivity point expiration			If the point expiration rule is set to Points Expire after a period of inactivity.
last_qualified_date	2021-05-20T18:25:43.511-04:00	String	The UTC date & time the of the last qualifying activity performed. This date must be an ISO-8601 compliant date field.
expiration_date	2021-05-20T18:25:43.511-04:00	String	The UTC date & time when the points will be expired. This date must be an ISO-8601 compliant date field.
points_expiring	200	Integer	Number of points that will be expiring if qualified activity is not performed.
Redemption period point expiration			If the point expiration rule is set to Points Expire after a set redemption period.
points_expired	0	Integer	Number of points expired in the given month.
points_expiring	100	Integer	Number of points expiring in the given month. It will be 0 for trailing months.
points_redeemed	40	Integer	Number of points redeemed in the given month.
expiration_date	2021-05-20T18:25:43.511-04:00	String	The UTC date & time the of points expiration per month. This date must be an ISO-8601 compliant date field.

Sample Request

When Multi Point expiration rules are set and member has points across different expiration rules. If only one default rule is set, either redemption_period_point_expired or inactivity_points_expiration will be shown.

{ "redemption_period_points_expiration": [ { "points_expired": 100, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-02-28T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-03-31T00:00:00.000Z" }, { "points_expired": 200, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-04-30T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 1000, "points_redeemed": 0, "expiration_date": "2022-05-31T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 3013, "points_redeemed": 120, "expiration_date": "2022-06-30T11:00:00.000Z" }, { "points_expired": 0, "points_expiring": 2000, "points_redeemed": 0, "expiration_date": "2022-07-31T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-08-31T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-09-30T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 1000, "points_redeemed": 0, "expiration_date": "2022-10-31T00:00:00.000Z" }, { "points_expired": 0, "points_expiring": 0, "points_redeemed": 0, "expiration_date": "2022-11-30T00:00:00.000Z" } ], "inactivity_points_expiration": [ { "last_qualified_date": "2022-05-25T08:45:41.000Z", "expiration_date": "2023-05-25T08:45:41.000Z", "days_until_expiry": 365, "points_expiring": 200 } ] }