LoyaltyRewardCatalog

A grouping of Rewards within a Loyalty Program. If multiple groups of Rewards are not required, users should create one catalog and use it to create all subsequent Rewards.

When updating, already existing fields omitted from the payload will generally not be deleted unless otherwise specified.

  • name
    Type: string
    required

    An identifier for a Catalog.

  • created_at
    Type: string Format: 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

    More details about this Reward Catalog.

  • id
    Type: integer
    read-only

    Integer numbers.

  • program_id
    Type: integer
    read-only

    Integer numbers.

  • status
    Type: string enum
    read-only
    values
    • pending
    • active
    • suspended
    • archived
  • tier_id
    Type: integer

    Optional tier ID for catalogs for if tiering is enabled.

  • updated_at
    Type: string Format: date-time
    read-only

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