> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integrating-perkville/integrating-your-app-with-perkville/loyalty-status-and-inactive-messaging.md).

# Loyalty status and inactive messaging

Use loyalty status and inactive messages in a connected application.

Applications receive loyalty status and messaging. They do not receive an error solely because a location has not activated.

Use these fields:

* `loyalty_program_status`
* `loyalty_launch_status`
* `effective_loyalty_launch_dt`
* `inactive_loyalty_message`

Evaluate both business and location status before showing normal earning, joining, referral, or reward activity. Applications decide whether to display, disable, or hide inactive locations.

Do not hide every non-active location automatically. An allowed activity may remain available while a location is inactive. Render `inactive_loyalty_message` as plain text, never trusted HTML.

When the business is inactive, use the business inactive message. When the business is active and the selected location is inactive, use the location message. Allowed actions still require normal agreements and eligibility checks.

### API-created locations

Omitting `loyalty_program_enabled` preserves historical API behavior for existing integrations. Do not add this field unless you need to control the new behavior.

An explicit `false` creates a location with loyalty inactive. Explicitly configured locations follow the current setup rules.

When the option is omitted, the location inherits business allowed activities. It does not receive a new creation-time historical-transaction cutoff.

See [Business program status](https://docs.perkville.com/features/settings/business/business-program-status.md), [Location program status](https://docs.perkville.com/features/settings/location-setup/locations/location-program-status.md), and [Activation and transaction dates](https://docs.perkville.com/features/settings/loyalty-activity-controls/activation-and-transaction-dates.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integrating-perkville/integrating-your-app-with-perkville/loyalty-status-and-inactive-messaging.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
