Offers API

Your offer catalog is the list of everything you sell (and grant) to players. Qyren needs this catalog to recommend anything. All endpoints require Authorization: Bearer qyr_live_<your-key>. Confirm the exact paths in your dashboard — endpoints other than /v1/ingest and /v1/recommend may vary by account configuration.

Import the catalog

POST https://api.qyren.ai/v1/offers/import

Request:

{
  "offers": [
    {
      "external_id": "starter_bundle_01",
      "name": "Starter Bundle",
      "description": "100 gems, 5,000 gold, one hero token.",
      "price_usd": 4.99,
      "price_tier": "starter",
      "contents_json": "{\"gems\":100,\"gold\":5000,\"hero_token\":1}",
      "is_active": true
    }
  ]
}

game_id is resolved from your API key — don’t include it in the body.

Offer fields

Field	Type	Required	Notes
`name`	string	yes	Display name.
`price_usd`	number	yes	Must be greater than 0.
`price_tier`	string	yes	Free-form tier label (e.g. `starter`, `mid`, `premium`).
`contents_json`	string	yes	JSON-encoded string describing what the player gets. Stored as opaque JSON.
`external_id`	string	recommended	Your stable ID. Acts as the upsert key on re-import. Without it, every import creates a new row.
`description`	string	no	Long-form copy. Accepted but not yet persisted.
`is_active`	bool	no	Defaults to `true`. `false` imports the offer in a paused state.
`sequence_id` / `sequence_step`	string / int	no	Reserved for future sequence binding. Accepted but not yet persisted.

Re-uploading the same external_id updates the offer in place. Omitted offers are not deleted — they’re left alone. Eligibility rules (level gates, segment targeting, time windows) are managed in the dashboard, not at import time. Limit: 500 offers per request.

List offers

GET https://api.qyren.ai/v1/offers

Returns the current catalog for the game tied to your API key. No query parameters required.

Deactivate an offer

Re-import the same external_id with "is_active": false. Historical performance is retained and the offer can be re-activated by importing again with "is_active": true. There is no separate deactivate or delete endpoint exposed on the public API today; for permanent removal, contact [email protected].

Offer sequences (optional)

If you have a designed funnel — e.g. starter → first-week → weekly — you can define a sequence so Qyren respects order and pacing. Sequences are managed via /v1/sequences (see dashboard for the full schema).

Getting Started

Core Concepts

Economy Health

Recommendations

Billing

Integration

API Reference

Glossary

Import the catalog

Offer fields

List offers

Deactivate an offer

Offer sequences (optional)

​Import the catalog

​Offer fields

​List offers

​Deactivate an offer

​Offer sequences (optional)

Import the catalog

Offer fields

List offers

Deactivate an offer

Offer sequences (optional)