Event - Profile Update Campaign
This includes information about profile update campaign events triggered as they happen in the Punchh system.
{
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1595593863,
"business_id": 7,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"event_name": "marketing_notifications",
"event_type": "profile_update_campaign",
"action": "create",
"payload": {
"amount": null,
"campaign_id": 105,
"campaign_name": "Phone Update Campaign",
"campaign_type": "ProfileUpdateCampaign",
"challenge_completed_steps": null,
"challenge_remaining_steps": null,
"challenge_total_steps": null,
"coupon_code": null,
"coupon_end_date": null,
"coupon_gift_value": null,
"coupon_reward_name": null,
"donation_type": null,
"for_referring_full_name": null,
"gift_reason": null,
"gifted_amount": null,
"item_donated": null,
"location_name": "",
"points": null,
"raw_referral_points": null,
"referral_points": null,
"reward_expiring_at": null,
"reward_expiring_at_tz": null,
"reward_id": 6974,
"reward_name": "Free Burger",
"user": {
"account_balance": {
"banked_currency": null,
"current_membership_level_name": "Silver Level",
"last_visit": null,
"loyalty_points": 0,
"net_balance": 10,
"net_debits": 0,
"pending_points": 0,
"total_credits": 10,
"total_debits": "0.0",
"total_lifetime_points": 10,
"total_point_credits": 10,
"total_redeemable_visits": null,
"total_visits": 0,
"unbanked_points": null,
"unredeemed_cards": null,
"user_id": 111111111
},
"anniversary": null,
"avatar_remote_url": null,
"birthday": "1999-01-01",
"email": "test@example.com",
"first_name": "FIRST_NAME_GOES_HERE",
"gender": null,
"guest_type": "Loyalty",
"last_activity_at": "2020-07-24T12:30:50Z",
"last_name": "LAST_NAME_GOES_HERE",
"marketing_email_subscription": true,
"marketing_pn_subscription": true,
"phone": "1111111111",
"preferred_locale": "en",
"secondary_email": null,
"signup_channel": "WebEmail",
"sms_subscription": false,
"unsubscribe_reason": null,
"unsubscribed": false,
"user_id": 111111111,
"user_status": "active"
}
}
}
Meta Fields
Meta Fields are common attributes such as content_id, timestamp, etc. that are returned in event responses, providing additional information about events. Click here to view the descriptions of the attributes.
Response Parameters
| Payload | ||
| amount | String | Payment amount |
| campaign_id | Integer | ID of the updated campaign |
| campaign_name | String | Name of the updated campaign |
| campaign_type | String | Type of the campaign |
| challenge_completed_steps | Integer | Challenge campaign completed steps |
| challenge_remaining_steps | Integer | Challenge campaign remaining steps |
| challenge_total_steps | Integer | Challenge campaign total steps |
| coupon_code | String | Code of the coupon |
| coupon_end_date | Date | Coupon validity end date |
| coupon_gift_value | String | Coupon gifted rewards value (amount/points, etc.) |
| coupon_reward_name | String | Coupon gifted reward name |
| donation_type | String | Donation type |
| for_referring_full_name | String | Name of the referral user |
| gift_reason | String | Reason/purpose message for gifting |
| gifted_amount | Integer | Amount gifted to the user |
| item_donated | String | Donation item |
| location_name | String | Location name of the check-in |
| points | Integer | Points to be offered by the campaign |
| raw_referral_points | Integer | Campaign gifted value |
| referral_points | String | Referring points |
| reward_expiring_at | Date | Expiry date of the reward |
| reward_expiring_at_tz | Date_Time | Expiry date of the reward with time zone |
| reward_id | Integer | Unique ID of the reward |
| reward_name | String | Name of the reward |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |