LoyaltyTier

Represents a single Loyalty Tier that Enrollments can be automatically or manually granted access to. Qualifications for being granted access to a tier are defined by active Tier Grant Rule(s).

See Loyalty Tier Grant for details about how Enrollments are granted access to Tiers, and how an Enrollment's Tier is determined.

  • name
    Type: string
    required

    short identifier for the tier

  • order
    Type: integer
    required

    determines hierarchy for tiers (higher is better). This needs to be unique across tiers.

  • program_id
    Type: integer
    read-only
    required

    Sparkfly ID of the Program

  • created_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string

    long-form summary or description of the tier

  • id
    Type: integer
    read-only

    Unique ID generated by Sparkfly

  • status
    Type: stringenum
    read-only

    determines whether or not enrollments can be granted access to this tier upon meeting the appropriate criteria (see Tier Grant Rules).

    values
    • pending
    • active
    • suspended
    • archived
  • updated_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z