> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yorlet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Loyalty programmes

> Create programmes, turn on automatic grants, and award points.

A programme is the rule for an occasion: the type, the points, and who can receive them. You create programmes from the [Loyalty programmes](https://dashboard.yorlet.com/loyalty/programs) page.

## Creating a programme

To create a programme, follow these steps:

1. Click **New programme** (or press **N**).
2. Enter a **Name**. Use this to organise your programmes. It is not shown to customers.
3. Enter a **Description**. This is shown to customers in the app.
4. Enter a **Statement descriptor**. This is shown on the customer's statement.
5. Choose a **Type**: **Rent on time**, **Tenure milestone**, **New lease**, **Renewal**, **Move in**, **Referral**, **In person**, **One time**, **Birthday**, or **Custom**.
6. Choose a **Reward type**. **Points** grants a fixed **Reward points** amount. **Earn rate** is available when the type is **Rent on time** or **Custom** — set **Currency unit**, **Points per unit**, and optionally **Maximum points**.
7. For types that support it, optionally turn on **Grant automatically**. For **Tenure milestone**, set **Months after tenancy start**.
8. Click **Create**.

<Tip>
  You can also click **New programme** from the empty state if you do not have any programmes yet.
</Tip>

## When automatic grants run

Turn on **Grant automatically** when you want Yorlet to award the programme without **Add usage**.

* **Rent on time** — an invoice is paid on or before its due date. Direct Debit can settle a few working days later and still count.
* **New lease** — an application is completed (a new letting, not a renewal).
* **Move in** — a tenancy becomes active.
* **Renewal** — a renewal is completed.
* **Tenure milestone** — an active tenancy reaches the months you set.
* **Birthday** — the customer's date of birth, only if they have an active tenancy. Date of birth is the **Legal date of birth** on the customer. Customers without a date of birth are skipped.
* **In person** — the customer checks in with the QR code or link. This is already automatic; there is no **Grant automatically** switch.

**Custom**, **One time**, and **Referral** have no built-in trigger. Use [a workflow](/loyalty/grant-with-a-workflow), **Add usage**, or the [API](/development/integrations/loyalty/grant-rewards).

<Warning>
  Do not also add a **Grant loyalty points** workflow for the same occasion, or customers can be rewarded twice.
</Warning>

## Advanced options

Click **Show more** for **Advanced options**:

* **Discoverable** — whether the programme is visible to residents in the app.
* **Expires** — after this date the programme expires and cannot be used.
* **Maximum redemptions** — the maximum number of times this programme can be redeemed.
* **Loyalty tier** — optionally restrict the programme to residents in a specific tier.
* **Recipient restriction** — **None** (any user in the OneMove network can receive points) or **Residents** (only residents in your account).
* **Enable budget** — set a **Time window** and **Maximum points**. The budget is stored on the programme; it does not currently stop grants.

## Awarding points manually

To grant a programme yourself, follow these steps:

1. Open the programme.
2. Click **Add usage**.
3. In **Create a loyalty program event**, choose a **Recipient type**: **Customer** or **Email**.
4. Pick the customer or enter the email.
5. For earn-rate programmes, enter the **Spend amount**.
6. Click **Create**.

The grant status is:

* `succeeded` — Yorlet matched a OneMove account.
* `pending` — there is no OneMove user yet. They can claim the points when they sign up.
* `expired` — the grant expired before it was claimed.

For **Custom**, **One time**, and **Referral**, you can also [grant points with a workflow](/loyalty/grant-with-a-workflow). If the grant comes from your own software, use the [developer integration guide](/development/integrations/loyalty/grant-rewards). To issue OneMove points from another product (purchases, and similar), see [Issue OneMove points](/development/integrations/onemove).

## In person

If the type is **In person**, the programme page shows **In-person** with a **Check-in QR code** URL you can copy. Customers earn the programme when they check in with that link.

## Editing a programme

To edit a programme, follow these steps:

1. Open the programme.
2. Click **Edit programme**.
3. Update the **Name**, **Description**, or **Statement descriptor**. For types that support it, you can also turn **Grant automatically** on or off, and set **Months after tenancy start** for **Tenure milestone**.
4. Click **Update**.

## Archiving a programme

Archived programmes cannot be used and are not visible to customers.

To archive a programme, open it, open the overflow menu (•••), and click **Archive**. Click **Unarchive** to restore an archived programme that is still **Active**.
