Club template configuration

To access the configuration page, open the Modules menu and search for the Clubs module. The page will open to a list of club templates (if already created), displaying the following information:

Creating a new club template

Click Create a new Club Template in the sidebar of the Clubs module to open the template’s Edit page.

Basic settings

• Enter the name of the club template.
  This name is for internal use only and it is used to identify the template in the list of templates.

• Select the type of the club template:

  • Public: Loyalty members can join the club via a link (no invitation or approval is needed).

  • Private: Loyalty members must receive an invitation to join the club.

• Enter the invitation settings. - Only applicable if the Club Template Type is set to Private

  • Next to Invitation Auto Accept, select whether invited loyalty members should automatically become a member with an active status, or if they should first receive an applicant status.
    Applicant members need the club owner’s permission to become full members of the club and to receive the active status.

  • In the Invitation Pattern field, enter the URL that will be used for the invitation link to join a private club. If left empty, the default URL is https://shop.antavo.com/.
    When an invitation ID to join a club is generated (via the Create an invitation to a club endpoint), it is added to the end of the URL provided in this field, creating the invitation link.

    📓

    In the front-end implementation of the loyalty program, you must ensure that the generated invitation link redirects to the Add a customer to a private club endpoint.

  • In the Invitation ID Validity field, enter the number of days for which the invitation will be valid.

• Set the club member limit.
  Specify the maximum number of members for each club. Note that the applicant members of a club are not included in the club’s total member count.

Contribution settings

• Select the contribution type.

  • Set percentage: If you select this option, the specified contribution percentage is deducted from the total amount of points earned by a club member at checkout and it is then added to the club’s points. The remaining points are credited to the club member’s account.

  • Additional percentage: If you select this option, the total amount of points earned by a club member at checkout is added to the club member’s account. Additionally, the specified contribution percentage, calculated from that amount, is added to the club’s points.

    📓

    To learn how to reward customers with points and how to set up the point earning logic, see Incentivized purchase.

• Specify the contribution percentage.
  The contribution percentage is based on the total amount of points earned by a club member at checkout.

• Next to Minimum Points Threshold, select whether the club point contribution should be activated only if a club member’s total amount of earned points at checkout matches or exceeds the specified threshold.

Club point expiration

• Select the club point expiration type:

  • No expiration: If this option is selected, the club points will never expire.

  • Rolling: Select this option to set a time period after which the club points will expire. The expiration date is calculated by adding the specified number of days to the date when the club points are earned. Points earned from different actions have distinct expiration dates.

  • Calendar: Select this option to specify one or more recurring dates on which the club points will expire.

• In the Expire After field, enter the number of days after which the club points will expire (e.g., 1 day, 1 week, 2 months, etc.). - Only applicable if the Expiration Type is set to Rolling
  The expiration date is calculated by adding the specified number of days to the date when the club points are earned. Points earned from different actions have distinct expiration dates.

• Next to Expiration Dates, click Add interval date to specify one or more recurring expiration dates by entering the month and day of each date. - Only applicable if the Expiration Type is set to Calendar
  Club points will expire annually on the selected dates.

Burn settings

• Next to Burn Eligibility, select who can spend club points:

  • All active members: Select this option to allow all club members to spend club points.

  • Owner only: Select this option to restrict the spending of club points to the club owner only.

• In the Membership Duration Requirement field, specify the minimum number of days that a member must part of a club before they can spend club points. - Only applicable if the Burn Eligibility is set to All active members
  Note that the value must be between 0 and 365 days.

• Mark the Enable the Limitation of Spending checkbox to limit the amount of club points that a club member can spend.
  Note that this limitation also applies to the club owner.

  • Next to Limit Reset Type, select the spending limitation logic:

    • The limit will not be reset: Select this option if the point spending limit can only be reached once, after which it will not be reset.

    • Fix date: Select this option to set one or more recurring dates on which the amount of spendable club points is reset.

    • Based on the customer’s first spending event: Select this option to reset the amount of spendable club points at a specified time interval.

  • Next to Limit Reset Dates, click Add reset interval date to specify one or more recurring reset dates by entering the month and day of each date. - Only applicable if the Limit Reset Type is set to Fix date
    The amount of spendable club points will be reset annually on the selected dates.

  • In the Limit Reset Interval field, enter the time interval after which the amount of spendable club points will be reset (e.g., 1 week, 2 months, etc.). - Only applicable if the Limit Reset Type is set to Based on the customer’s first spending event
    Each reset date is calculated by adding the set time interval to the date of the club member’s first point spending action or to the date of the first such action following a limit reset.

  • In the Spending Limit field, enter the number of club points that each club member can spend according to the specified spending limitation logic.

Edit permissions

• Mark the Club Name is Editable checkbox to allow club members with the appropriate permissions to change the club’s name via the Clubs API.
  Note that Management UI admins can always change the club’s name on the club’s Details page, regardless of this setting.

The following settings are only available if the Club Name is Editable checkbox is marked:

• Next to Authorised Role for Club Name Change, select who can change the club’s name:

  • Owner only: Select this option to allow only the club owner to change the club’s name.

  • All active members: Select this option to allow all club members to change the club’s name.

• Mark the Limit Name Change checkbox if you want to set a limit for how many times the club’s name can be changed. Leave it unmarked to allow an unlimited number of name modifications.

• In the Change Frequency field, enter the number of times that the club’s name can be changed within the defined period (e.g., 1/Day, 3/Year, etc.). - Only applicable if the Limit Name Change checkbox is marked

Points economy

If the Multi-accounts module is enabled in the loyalty program, the Account dropdown field appears at the bottom of the page. Use this field to select at least one account whose point earning events will be considered when calculating the point contribution for clubs created with this template.

To create the club template, click Create at the bottom of the page.

Activate a club template

After you create a club template, its status is set to draft by default. Draft templates appear in the list of club templates on the Clubs module configuration page, but they cannot be used to create new clubs until they are activated.

To activate the club template immediately after creation, click the Set active button on the upper right-hand side of the template’s Details page, then confirm the activation in the dialog that appears. The template’s status is changed to active.

You can also activate a club template from the Club Templates menu in the module’s sidebar navigation. Open the hamburger menu at the end of the template’s row, click Set active, and then confirm the activation in the dialog that appears. The template’s status is changed to active.

Once a club template is activated, the following settings can no longer be edited:

• Club template type

  • If the type is set to Private, you also cannot edit the Invitation Auto Accept settings.

• Contribution type

• Minimum points threshold

• Point expiration type

• All burn settings, except for the spending limit if the limitation of spending is enabled.

After a template is activated, some settings (e.g., Club Template Type and Invitation Auto Accept) can no longer be edited.

Managing club templates

Edit a club template

• Go to the Club Templates page in the sidebar of the Clubs module.

• Click the hamburger button of the club template you want to edit.

• Click Details to open the Edit page.

• Modify the settings of the club template as needed.

• Click Update to save your changes.
  A confirmation message of the successful action is displayed at the top of the page.

Clone a club template

You can clone an existing club template to create a new template with the same or similar settings:

• Go to the Club Templates page in the sidebar of the Clubs module.

• Click the hamburger button of the club template you want to clone.

• Click Clone.
  The Edit page of the new template opens, but the template is not yet created.

• Modify the template’s settings as needed.

  Note that the name of the clone template is modified by default to reflect the cloning action. You can change the name before creating the clone template, or you can edit it later.

• Click Create.
  A confirmation message of the successful action is displayed at the top of the page, and the new template is created with a draft status.

Archive a club template

To archive a club template in the Management UI:

• Go to the Club Templates page in the sidebar of the Clubs module.

• Click the hamburger button of the club template you want to archive.

• Click Archive.

• Confirm the action in the dialog that appears.
  A confirmation message of the successful action is displayed at the top of the page, and the template’s status is changed to archived.

Note that archived templates are hidden by default. To display the archived templates in the list of club templates, use the filter at the top of the page.

Filter the list of club templates

To filter the club templates on the Club Templates page of the Clubs module:

• In the Search field at the top of the Club Templates page, enter one or more filter criteria.
  You can filter the results by the club template’s ID, name, type, status, or by the associated account.

• Click Search to display the filtered list.

To reset the filter, click the X button at the end of the field.