The members object will contain all the member details and attributes that a member has. This includes the predefined attributes as well as the custom attributes defined in the Zinrelo admin console.
A sample JSON of the members object is shown below.
{
"lifetime_points_earned": 100,
"twitter_handle": "www.twitter.com/john",
"revenue": 0,
"lifetime_points_expired": 0,
"last_modified_date": "03/10/2023 09:24:29",
"available_points": 100,
"last_name": "Doe",
"referral_URL": "https://zinrelo.com//ref/JOH4F47O",
"member_status": "active",
"referral_code": "JOH4F47O",
"email_address": "[email protected]",
"id": "640af74c955940000a629a67",
"first_name": "John",
"number_of_activities": "",
"member_tags": [
"membercreated",
"memberadded",
"addedmember"
],
"referrer_code": "ANN9PJZN",
"tier_info": {
"current_period_start": "03/01/2023",
"loyalty_tier_name": "Silver",
"loyalty_tier_id": "zrl_silver",
"current_period_end": "03/31/2023",
"qualified_points": 100
},
"custom_attributes": {
"City_Name": "Paris",
"Marital_Status": "Married",
"Income_Source": "Service",
"Age_In_Years": "37",
"Gender_Identity": "Male",
"Graduation_Date": "15/12/1989 00:00:00"
},
"referrer_ID": "6409c685c487dc000b2b3039",
"first_purchase_date": null,
"lifetime_points_deducted": 0,
"phone_number": "+1-6507017759",
"points_expiration_schedule": [
{
"expiration_date": "11-Feb-2024 9:24:29",
"points": 100
}
],
"instagram_handle": "www.instagram.com/john",
"referrer_name": "Anna Scott",
"aov": 0,
"address": {
"city": "Superior",
"country": "US",
"line2": "",
"line1": "1000 S. McCaslin Blvd., Suite 301",
"state": "CO",
"postal_code": "12345"
},
"deleted_date": null,
"last_purchase_date": null,
"lifetime_points_redeemed": 0,
"preferred_language": "english",
"number_of_purchases": 0,
"gender": null,
"number_of_redemptions": 0,
"birthdate": "01/31/1900",
"anniversary_date": "07/07/2021",
"enrollment_date": "03/10/2023 09:24:28",
"member_id": "greatMRT01003012",
"email_subscription_status": "subscribed"
}
The members resource will have the following API endpoints:
- Create a loyalty member: This endpoint will create a loyalty member.
- Retrieve a loyalty member: This endpoint will retrieve a loyalty member object identified by the :id or :member_id.
- Update a loyalty member: This endpoint will update the specified member by setting the values of the parameters passed. Any parameters not passed will be left unchanged.
- Delete a loyalty member: This API endpoint will soft delete the loyalty member.
- List all members: This API endpoint returns a list of all members. By default, the members are returned sorted by enrollment_date, with the most recent members appearing first.