ChallengeListingItem

End date and time of the challenge in the business timezone (ISO 8601 format)

Challenge ID

Returns the type of challenge reach strategy defined on the challenge campaign. Possible values are:

• universal_auto_enrolment
• segment_auto_enrolment
• null (when no reach strategy is defined)

Start date and time of the challenge in the business timezone (ISO 8601 format)

Returns the details of availability of and enrollment of a guest into a specific challenge. Possible values are:

• unavailable: This status will be returned for "segment_auto_enrolment" when a guest is NOT added to the "user_feature_enrolment" table.
• enrolled: This status will be returned for:
  a) "universal_auto_enrolment" in all cases since all signed-up guests are automatically enrolled for the challenge.
  b) "segment_auto_enrolment" in cases when guests from the attached segment (to the challenge campaign) get added to the user_feature_enrolment table and are automatically enrolled for the challenge.
  
• null: For older default "Segment" type challenges, the status will always be null.

Returns the type of challenge that is configured in the Punchh platform. Supported values are:

• receipt_qualification
• every_x_points
• segment

Description of the challenge. The description is returned in the language specified in the Accept-Language request header, provided the challenge description has been translated into the relevant language by the business admin in the Punchh platform when creating or editing a challenge campaign under Marketing Automation > Campaign Management. If the translation is unavailable, the response returns the value for this parameter in the default English language. For example, if the header specifies "fr" (French), the description is returned in French if a French translation is configured for the description in the Punchh platform; otherwise the value is returned in the default English language.

End date of the campaign

Indicates whether the challenge requires explicit opt-in from the user before enrollment

Reason to give gifts to a user

URL of the image icon that represents completion of the challenge

URL of the default icon image for the challenge

URL of the main banner image associated with the challenge campaign

Returns miscellaneous response string as configured in the Punchh platform

Name of the challenge. The name is returned in the language specified in the Accept-Language request header, provided the challenge name has been translated into the relevant language by the business admin in the Punchh platform when creating or editing a challenge campaign under Marketing Automation > Campaign Management. If the translation is unavailable, the response returns the value for this parameter in the default English language. For example, if the header specifies "fr" (French), the name is returned in French if a French translation is configured for the name in the Punchh platform; otherwise the value is returned in the default English language.

Possible values are:

• single - Shows when restarting the challenge button is OFF in the campaign
• multiple - Shows when restarting the challenge button is ON in the campaign

Indicates whether the user has opted in to a challenge. Possible values:

• true - The user has opted in. The mobile app should show the opt-out button on the challenge card if the opt-out feature is enabled for the business in the Punchh platform.
• false - The user has not opted in. The mobile app should show the opt-in button on the challenge card if the opt-in feature is enabled for the business in the Punchh platform. Contact your Punchh representative to update this configuration setting.

Indicates whether the user has opted out of the challenge

The number of times the user has previously completed the challenge campaign.

Array of progress objects showing completed steps and total steps for the challenge

Start date of the campaign