Fields

enrollmentStatus : OctoplusEnrollmentStatus

The current enrollment status of the account.
isLoyaltyPointsUser : Boolean

Describes whether or not the request user is the nominated user for this account.
isOctoplusEnrolled : Boolean

Describes whether or not this account is enrolled in the Octoplus campaign.
Deprecation
The 'isOctoplusEnrolled' field is deprecated.

Please use enrollmentStatus instead

- Marked as deprecated on 2025-02-20.
- Scheduled for removal on or after 2025-08-01.
octoplusEligibility : OctoplusEligibilityType

Information about an account's eligibility for joining the Octoplus campaign.
octoplusSnapWebUrl : OctoplusSnapWebUrlType

URL for the octoplus snap page if account is eligible.
shouldUseV2 : Boolean

Describes if the account should use v2.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "enrollmentStatus": "ENROLLED", "isLoyaltyPointsUser": true, "octoplusEligibility": OctoplusEligibilityType, "octoplusSnapWebUrl": OctoplusSnapWebUrlType, "shouldUseV2": true }