How to Lock Content and Generate Access Codes

Access codes let you control who can view your tours, collections, and app content. You can lock content behind a code so only people with a valid code can access it. This guide walks you through setting up content locks and generating access codes on the new STQRY Builder.

Prerequisites

• You must be logged in as an Account Admin.
• Log in at https://beta-us.stqry.com

Step 1: Open the Publisher Dashboard

From the STQRY Dashboard, click Publishing in the left sidebar. This opens the Publisher Dashboard where you can manage your codes, pricing, earnings, and credit balance.

Step 2: Set Up Pricing and Lock Your Content

Before generating codes, you need to create a product and enable the code lock.

1. On the Publisher Dashboard, click the Pricing & Distribution tab.

2. Click Add new to create a new product.

3. In the Add new product dialog:

• Select project — choose the project this product belongs to.
• Apply pricing for — select whether the pricing applies to the Whole app, a Bundle of tours/lists, or an Individual tour/list.
• Select collection — if applicable, choose the specific collection to lock.

4. Under Product price, set the price for each platform (iOS, Android, Web). To lock content behind a code, toggle on Code — Require an access code if no price is set. You can also combine both options — set a price for some platforms and require a code for others.

5. Under Product details & lock, you can customize:

• In app purchase details — edit the product title and description shown before purchase.
• Code lock screen — edit the details that will appear on the code lock screen.

6. Click Save & Close to save your product.

Step 3: Generate Access Codes

Once your content is locked, you can generate codes for distribution.

1. On the Publisher Dashboard, click the Manage Codes tab.

2. Click the Generate Codes button in the top-right corner.

3. In the Generate codes dialog:

• Project — select the project.
• Use access code for — choose Whole app, Bundle of tours/lists or Individual tour/list
• Collection — select the specific collection.
• Choose between One code or Multiple codes using the tabs at the top.

4. Configure the code details:

• Access code — enter a custom code under the "One code" tab, or switch to the "Multiple codes" tab to auto-generate a specified number of codes.
• Maximum number of redemptions — set how many times this code can be used. Enter 1 for a single-use code, or leave blank for unlimited redemptions.
• Code duration — set how long the code is valid (in days or hours).
• Set access code validity range — toggle on to set a specific start and end date for the code.
• Time zone — select the time zone for the validity dates.

5. Click Generate Code to create the code.

Managing Your Codes

After generating codes, you can manage them from the Manage Codes tab:

• View all codes — see a list of all codes with their status, redemption count, and validity dates.
• Search and filter — use the search bar and filter options to find specific codes.
• Import codes — STQRY allows you to upload a batch of access codes to unlock specific tours, collections, or full app access. To get started, download the access code template and complete it according to your access needs. Once filled out, share the file with your Customer Success Manager or email it to support@stqry.com for processing.
  Required Fields:
  • coupon_code (required): The code users will enter in the app. Each code must be unique for a given linked_id and linked_type.
  • linked_id (required): The ID of the Collection (e.g., Tour or List) or Project (if the code unlocks the entire app).
    If you’re unsure about which ID to use, please check with your Customer Success Manager.
  • linked_type (required): Skip this field for now. Bundles are not yet supported. This field will be updated once the feature becomes available.
  • Optional Fields:
    • valid_from: The start date when the access code becomes active.
    • valid_to: The end date after which the access code becomes invalid.
    • timezone: Specifies the timezone for the valid_from and valid_to dates (if used).
    • max_redemptions: Limits the number of times a access code can be redeemed. Leave blank for unlimited use.
    • expire_after: Sets a time limit (in hours) after the first use, after which the access code will expire. Leave blank for no expiry after redemption.
    • tags: A semicolon-separated list of tags you can add to help organize and locate items more easily in the builder. Note that the system will also add an automatic import tag
• Download CSV — click Download CSV to export your codes for distribution.
• Archive codes — select codes and click Archive to deactivate them.

Generating Codes via API

For advanced use cases, STQRY offers free API support for dynamically generating customized access codes in real time. This is ideal for automating code creation through your own systems or integrations.

When setting up code generation via the API, you will need to specify the following parameters:

• linked_id — the Project ID or Collection ID that the code will unlock.
• linked_type — either "Project" or "Collection", depending on what the code unlocks.
• project_id — the project this code should be associated with.

You can find the full API reference at developer.stqry.com/api.html. To generate and manage access codes, refer to these endpoints:

• POST /api/public/codes — create a new code
• PUT /api/public/codes/{id} — update an existing code

Note: To obtain your API key, Project ID, and Collection ID, please contact the STQRY support team at support@stqry.com.

Important Notes

• Each code redemption uses 1 credit. Make sure your account has enough credits available. See Understanding Credits on STQRY for details on how credits work.

Frequently Asked Questions

What happens when a code is redeemed?

The user enters the code in the app or web experience, and the locked content becomes accessible. One credit is consumed per redemption.

Can I edit a code after creating it?

You can archive a code and create a new one, but existing codes cannot be modified after generation.

Can I use codes without setting a price?

Yes. Toggle on the Code option under Product price and leave the price set to Free. Users will need a valid code to access the content, but no payment is required.

How do I track code usage?

The Manage Codes tab shows redemption counts for each code. The Publisher Dashboard also displays overall code volume and sales data.

What happens after a code expires or is cancelled?

Once a code passes its validity date or is cancelled, the end user will no longer have access to the locked tour content.

If you have any questions or need help setting up content locks, contact your CSM or reach out to support@stqry.com.