Fuel and Convenience Profile

API Reference

Fuel and Convenience Profiles are exposed via an API resource called Fuel and Convenience Profiles.

What is a Fuel and Convenience Profile

A Fuel and Convenience Profile is an optional profile that may be created on behalf of a member in a fuel- and/or convenience-related loyalty program. The Profile supports attributes that help a loyalty program to build a better relationship with its members via tailored marketing communication, or personalized Offers.

How are Fuel and Convenience Profiles configured?

A given member may only have one Fuel and Convenience Profile (in addition to any other types of supported Profiles they might have), which may be created and configured via normal interaction with the Hatch API. The Fuel and Convenience Profile supports the following attributes:

acquisition_channel (string)
A free-form text-field that may be used to indicate the channel by which the member was acquired, e.g., pump, cashier, or POS.

alcohol_verified (boolean)
Whether the member has performed any age-verification and/or opt-in steps required to receive alcohol-related communications and Offers.

altria_verified (boolean)
Whether the member has performed any age-verification and/or opt-in steps required to receive tobacco-related communications and Offers from Altria.

rjr_verified (boolean)
Whether the member has performed any age-verification and/or opt-in steps required to receive tobacco-related communications and Offers from RJ Reynolds.

Once created, a Fuel and Convenience Profile may be used to inform relevant marketing communications. The profile may also be used to inform the targeting of an Offer via the Fuel And Convenience Attribute Audience.