# Thanx

## Docs

- [Introduction](https://docs.thanx.com/overview/intro.md)
- [Integrating with Thanx](https://docs.thanx.com/overview/integrating.md)
- [Sandbox Gotchas & FAQ](https://docs.thanx.com/overview/sandbox-faq.md)
- [Loyalty Models](https://docs.thanx.com/overview/loyalty-models.md)
- [Basket Lifecycle & Troubleshooting](https://docs.thanx.com/overview/guides/basket-lifecycle.md)
- [Campaign & Reward Issuance](https://docs.thanx.com/overview/guides/campaign-reward-issuance.md)
- [Consumer UX](https://docs.thanx.com/overview/guides/consumer-ux.md)
- [Pay-At-Table](https://docs.thanx.com/overview/guides/pay-at-table.md)
- [POS / Kiosk](https://docs.thanx.com/overview/guides/pos-kiosk.md)
- [Subscriber Ingestion](https://docs.thanx.com/overview/guides/subscriber-ingestion.md)
- [Postman API Collections](https://docs.thanx.com/overview/api_collections.md)
- [Overview](https://docs.thanx.com/consumer/overview.md)
- [Points Integration](https://docs.thanx.com/consumer/guides/points.md)
- [Push Notifications](https://docs.thanx.com/consumer/guides/push-notifications.md): Thanx sends users push notifications in a variety of situations, such as when they make a purchase or earn a reward.
- [Deep Linking](https://docs.thanx.com/consumer/guides/deep-linking.md)
- [Design Best Practices](https://docs.thanx.com/consumer/best-practices/design.md)
- [Card Enrollment Best Practices](https://docs.thanx.com/consumer/best-practices/enrollment.md)
- [Onboarding & Authentication](https://docs.thanx.com/consumer/best-practices/onboarding-authentication.md)
- [Loyalty & Rewards Best Practices](https://docs.thanx.com/consumer/best-practices/loyalty.md)
- [Feedback & Support Best Practices](https://docs.thanx.com/consumer/best-practices/feedback.md)
- [Messaging Best Practices](https://docs.thanx.com/consumer/best-practices/messaging.md)
- [Patterns](https://docs.thanx.com/consumer/usage/patterns.md): This section calls out some patterns in this API.
- [Headers](https://docs.thanx.com/consumer/usage/headers.md): This section describes the headers expected by the Thanx API.
- [Errors](https://docs.thanx.com/consumer/usage/errors.md): Thanx uses standard HTTP error codes to communicate the success / failure of a request.
- [Legal](https://docs.thanx.com/consumer/usage/legal.md)
- [Certification](https://docs.thanx.com/consumer/usage/certification.md): A Consumer API integration must be certified before production credentials are made available.
- [Create User](https://docs.thanx.com/consumer/users/create-user.md)
- [Get User](https://docs.thanx.com/consumer/users/get-user.md): This endpoint will return information for the currently logged in user.
- [Update User](https://docs.thanx.com/consumer/users/update-user.md): This endpoint updates the specified user's information.
- [Delete User](https://docs.thanx.com/consumer/users/delete-user.md): Submits a request for user account closure
- [Get Check In Code](https://docs.thanx.com/consumer/users/check-in-code.md): This endpoint will return the check-in code for a user. The check-in code can be matched to a location.
- [Single Sign-On (SSO) Overview](https://docs.thanx.com/consumer/sso/overview.md): This section describes the process of authenticating with Thanx via Thanx SSO.
- [Legal Requirements](https://docs.thanx.com/consumer/sso/legal-requirements.md)
- [Acquire Authorization Code](https://docs.thanx.com/consumer/sso/acquire-auth-code.md): This endpoint triggers the passwordless login flow.
- [Acquire Authorization Code (Cross-Domain)](https://docs.thanx.com/consumer/sso/acquire-auth-code-cross-domain.md): Generate an OAuth authorization code for an authenticated user without sending email.
- [Acquire Access Token](https://docs.thanx.com/consumer/sso/acquire-access-token.md): Use this endpoint to acquire a user's access token.
- [Revoke Access Token](https://docs.thanx.com/consumer/sso/revoke-access-token.md): Use this endpoint to revoke a user's access token.
- [Get Locations](https://docs.thanx.com/consumer/locations/get-locations.md): This endpoint describes locations accessible for the provided client ID. If a merchant_id is provided the locations will be further filtered.
- [Get Features](https://docs.thanx.com/consumer/features/get-features.md): This endpoint returns the configuration for a merchant's features. If a merchant does not have a particular feature defined or enabled, the value for the associated feature key will be empty.
- [Create Card](https://docs.thanx.com/consumer/cards/create-card.md): This endpoint registers a new card with Thanx.
- [Get Cards](https://docs.thanx.com/consumer/cards/get-cards.md): This section describes endpoints that enable a third party to fetch and register a user's cards. This endpoint describes all registered cards for the given user.
- [Delete Card](https://docs.thanx.com/consumer/cards/delete-card.md): This endpoint archives a registered card. The card is unenrolled from Visa/Mastercard/Amex.
- [Reward Overview](https://docs.thanx.com/consumer/rewards/overview.md): The Thanx platform supports a number of different reward redemption types — allowing for significant flexibility in what brands can offer to their users.
- [Get Rewards](https://docs.thanx.com/consumer/rewards/get-rewards.md): This endpoint returns a user's rewards.
- [Get Reward](https://docs.thanx.com/consumer/rewards/get-reward.md): This endpoint returns the reward corresponding to the ID in the path.
- [Activate Reward](https://docs.thanx.com/consumer/rewards/activate-reward.md): This endpoint activates the reward, transitioning reward state from available to active. For bonus points (also know as static rewards), this endpoint sets the reward state to used after activation (see [overview](/consumer/rewards/overview) for more information).
- [Finalize Reward](https://docs.thanx.com/consumer/rewards/finalize-reward.md): This endpoint marks an unused reward as used, transitioning the reward state from active to used.
- [Grant Reward](https://docs.thanx.com/consumer/rewards/grant-reward.md): This endpoint grants the user a reward associated with the campaign provided.
- [Update reward](https://docs.thanx.com/consumer/rewards/update-reward.md): This endpoint updates the redemption location for an active reward.
- [Get Signup Programs](https://docs.thanx.com/consumer/signup-programs/get-signup-programs.md): This endpoint returns active signup programs.
- [Get Signup Program](https://docs.thanx.com/consumer/signup-programs/get-signup-program.md): This endpoint returns a specific signup program by its handle.
- [Get Tags](https://docs.thanx.com/consumer/tags/get-tags.md): This section describes endpoints that enable a third party to fetch and update a user's tags. This endpoint describes all attribute tags for the given user.
- [Update Tags](https://docs.thanx.com/consumer/tags/update-tags.md): This endpoint updates an attribute tag for the given user. The tag associated with the key in the request will be created or updated with the values passed in.
- [Delete Tag](https://docs.thanx.com/consumer/tags/delete-tag.md): This endpoint deletes an attribute tag with the given ID.
- [Get Communication Settings](https://docs.thanx.com/consumer/communication-settings/get.md): This endpoint returns a user's communication settings. The notification key reflects a user's settings for receiving push notifications in their app. The email key reflects a user's settings for receiving emails. The sms key (under marketing_general) reflects a user's settings for receiving SMS mess…
- [Get Communication Setting by UID](https://docs.thanx.com/consumer/communication-settings/get-by-uid.md): This endpoint returns a specific communication setting by its UID. No authentication is required for this endpoint.
- [Update Communication Settings](https://docs.thanx.com/consumer/communication-settings/update.md): This endpoint allows the update of a user's notification / email settings.
- [Create Push Registration](https://docs.thanx.com/consumer/push/create-push-registration.md): This endpoint creates or updates a push registration record for a user's device.
- [Get Points Experiences](https://docs.thanx.com/consumer/points/get-experiences.md): This endpoint returns the points experiences for the merchant.
- [Get Points Experience](https://docs.thanx.com/consumer/points/get-experience.md): This endpoint returns a single points experience specified by ID.
- [Get Points Balance](https://docs.thanx.com/consumer/points/get-points-balance.md): This endpoint returns the specified points experience balance for the given user
- [Get Points Products](https://docs.thanx.com/consumer/points/get-products.md): This endpoint returns the configured points products.
- [Get Points Multipliers](https://docs.thanx.com/consumer/points/get-points-multipliers.md): This endpoint returns the configured points multipliers for the experience.
- [Exchange Points Product](https://docs.thanx.com/consumer/points/exchange-product.md): This endpoint exchanges the user's points for the specified points product
- [Get Tiers Configurations](https://docs.thanx.com/consumer/tiers/get-configs.md): This section describes endpoints that enable a third party to fetch the configuration of a merchant's tiers. This endpoint describes tier configurations for the merchants accessible via the provided credentials.
- [Get Tier Statuses](https://docs.thanx.com/consumer/tiers/get-statuses.md): This endpoint describes the user's current tier statuses.
- [Grant Tier Status](https://docs.thanx.com/consumer/tiers/grant-status.md): Grant Tier Status
- [Get Feedbacks](https://docs.thanx.com/consumer/feedbacks/get-feedbacks.md): This endpoint describes the user's current feedback records.
- [Get Feedback](https://docs.thanx.com/consumer/feedbacks/get-feedback.md): This endpoint returns the feedback record corresponding with the ID in the path.
- [Update Feedback](https://docs.thanx.com/consumer/feedbacks/update-feedback.md): This endpoint will update a user's feedback record.
- [Gift Cards Overview](https://docs.thanx.com/consumer/gift-cards/overview.md): The Thanx platform allows users to securely store and manage gift cards for convenient redemption.
- [Get Gift Cards](https://docs.thanx.com/consumer/gift-cards/get-gift-cards.md): This endpoint returns a paginated list of a user's active gift cards.
- [Create Gift Card](https://docs.thanx.com/consumer/gift-cards/create-gift-card.md): This endpoint adds a new gift card to a user's account.
- [Get Gift Card](https://docs.thanx.com/consumer/gift-cards/get-gift-card.md): This endpoint returns a single gift card with its current balance.
- [Delete Gift Card](https://docs.thanx.com/consumer/gift-cards/delete-gift-card.md): This endpoint archives a gift card, removing it from the user's active list.
- [Get Merchant Configuration](https://docs.thanx.com/consumer/gift-cards/get-merchant-config.md): This endpoint returns the merchant's gift card configuration for UI rendering.
- [Create Purchase](https://docs.thanx.com/consumer/purchases/create-purchase.md): This endpoint submits a purchase to our system for processing. Because this purchase is processed asynchronously, there is no response JSON. Please allow up to a couple minutes to receive this purchase back from the GET /purchases endpoint.
- [Get Purchases](https://docs.thanx.com/consumer/purchases/get-purchases.md): This section describes endpoints that enable a third party to fetch a user's purchases. This endpoint describes all available purchases.
- [Get Purchase](https://docs.thanx.com/consumer/purchases/get-purchase.md): This endpoint returns the purchase associated with the id in the path.
- [Update Purchase Tags](https://docs.thanx.com/consumer/purchases/update-tags.md): This endpoint updates an attribute tag for the given purchase. The tag associated with the key in the request will be created or updated with the values passed in.
- [Overview](https://docs.thanx.com/consumer/receipts/overview.md)
- [Create Receipt](https://docs.thanx.com/consumer/receipts/create-receipt.md): This endpoint submits a receipt for processing.
- [Get Receipts](https://docs.thanx.com/consumer/receipts/get-receipts.md): This endpoint describes the receipts in Thanx.
- [Get Upload URL](https://docs.thanx.com/consumer/receipts/get-upload-url.md): This endpoint provides a pre-signed url where an image or file can be uploaded.
- [Archive Overview](https://docs.thanx.com/consumer/archive/overview.md)
- [Get Loyalty Statuses](https://docs.thanx.com/consumer/loyalty/get-loyalty-statuses.md): This endpoint describes the user's current loyalty statuses.
- [Overview](https://docs.thanx.com/partner/overview.md)
- [Get Scopes](https://docs.thanx.com/partner/metadata/get-scopes.md): Returns API scopes accessible to the current credentials
- [Get Merchants](https://docs.thanx.com/partner/metadata/get-merchants.md): This endpoint will return all accessible merchants records
- [Get Locations](https://docs.thanx.com/partner/metadata/get-locations.md): This endpoint will return all accessible location records
- [Create Subscriber](https://docs.thanx.com/partner/subscribers/create-subscriber.md)
- [Get Users](https://docs.thanx.com/partner/users/get-users.md): This endpoint will return all the users of the specified merchant.
- [Get User](https://docs.thanx.com/partner/users/get-user.md): This endpoint will return one particular user of the specified merchant.
- [Update User](https://docs.thanx.com/partner/users/update-user.md): This endpoint will update one particular user of the specified merchant.
- [Create Access Token](https://docs.thanx.com/partner/auth/create-token.md)
- [Create Purchase](https://docs.thanx.com/partner/purchases/create-purchase.md): This endpoint submits a purchase to Thanx for processing. This allows for issuance of loyalty points to the given user.
- [Get Tags](https://docs.thanx.com/partner/tags/get-tags.md)
- [Upsert Tags](https://docs.thanx.com/partner/tags/upsert-tags.md)
- [Delete Tags](https://docs.thanx.com/partner/tags/delete-tags.md)
- [Get Feedback Records](https://docs.thanx.com/partner/feedbacks/get-feedbacks.md)
- [Respond to Feedback](https://docs.thanx.com/partner/feedbacks/feedback-response.md)
- [Get User's Communication Settings](https://docs.thanx.com/partner/users/communication-settings/get.md): This endpoint returns a user's communication settings for the specified merchant. The notification key reflects a user's settings for receiving push notifications in their app or via text if they don't have an app installed. The email key reflects a user's settings for receiving emails.
- [Update User's Communication Settings](https://docs.thanx.com/partner/users/communication-settings/update.md): This endpoint allows the update of a user's notification / email settings for the specified merchant.
- [List Reward Templates](https://docs.thanx.com/partner/reward-templates/list-reward-templates.md): Returns published reward templates for a merchant
- [Get Reward Template](https://docs.thanx.com/partner/reward-templates/get-reward-template.md): Returns a specific published reward template
- [Create Campaign](https://docs.thanx.com/partner/campaigns/create-campaign.md): Creates a new campaign with variants
- [List Campaigns](https://docs.thanx.com/partner/campaigns/list-campaigns.md): Returns active campaigns for a merchant
- [Get Campaign](https://docs.thanx.com/partner/campaigns/get-campaign.md): Returns a specific campaign
- [Issue Rewards](https://docs.thanx.com/partner/campaigns/issue-rewards.md): Issue rewards to users for a campaign variant
- [Promotions Overview](https://docs.thanx.com/partner/promotions/overview.md): How to create promotions, generate codes, and dispense them to customers
- [Create Promotion](https://docs.thanx.com/partner/promotions/create-promotion.md): Create a new promotion for a merchant
- [List Promotions](https://docs.thanx.com/partner/promotions/list-promotions.md): Returns active promotions for a merchant
- [Get Promotion](https://docs.thanx.com/partner/promotions/get-promotion.md): Returns a single active promotion
- [List Promotion Codes](https://docs.thanx.com/partner/promotions/list-codes.md): Returns the codes for a promotion's active pool
- [Generate Promotion Codes](https://docs.thanx.com/partner/promotions/generate-codes.md): Add a batch of single-use codes to an existing promotion
- [Get Issuance Job](https://docs.thanx.com/partner/issuance-jobs/get-issuance-job.md): Returns the status of a reward issuance job
- [Revoke Issuance Job](https://docs.thanx.com/partner/issuance-jobs/revoke-issuance-job.md): Revoke all rewards issued by an issuance job
- [Overview](https://docs.thanx.com/loyalty/overview.md)
- [AWS PrivateLink](https://docs.thanx.com/loyalty/private-link.md): Connect to Thanx Loyalty APIs over AWS PrivateLink
- [Headers](https://docs.thanx.com/loyalty/headers.md): All Ordering / Loyalty integration API endpoints described below must include the following headers.
- [Get Account](https://docs.thanx.com/loyalty/get-account.md): This endpoint allows the retrieval of a user account information, including the user's rewards.
- [Create & Update Basket](https://docs.thanx.com/loyalty/create-update-basket.md): This endpoint is used to notify Thanx of the states that a basket is in, apply rewards to the order, and accrue loyalty progress or points for the order.
- [Qualifying Rewards for a Basket](https://docs.thanx.com/loyalty/qualifying-baskets.md): Returns the subset of the user's rewards and points products that would actually produce a discount against a given basket. Read-only dry-run companion to Create & Update Basket — no state is mutated, no reward is redeemed, and no points are debited.
- [Overview](https://docs.thanx.com/webhooks/overview.md)
- [Purchases](https://docs.thanx.com/webhooks/purchases.md)
- [Reward Issued](https://docs.thanx.com/webhooks/reward-issued.md)
- [Reward Batch Completed](https://docs.thanx.com/webhooks/reward-batch-completed.md)
- [Communication Settings](https://docs.thanx.com/webhooks/communication-settings.md)
- [SMS Subscriptions](https://docs.thanx.com/webhooks/sms-subscriptions.md)
- [Overview](https://docs.thanx.com/data/overview.md)
- [Changelog](https://docs.thanx.com/data/changelog.md)
- [Snowflake Secure Data Sharing](https://docs.thanx.com/data/snowflake-data-sharing.md): Share Thanx data directly into your Snowflake account using Snowflake's native secure data sharing.
- [Connex Setup](https://docs.thanx.com/data/connex/setup.md)
- [Snowflake](https://docs.thanx.com/data/connex/snowflake.md): Configuring your Snowflake destination.
- [BigQuery](https://docs.thanx.com/data/connex/bigquery.md): Configuring your BigQuery destination.
- [Redshift](https://docs.thanx.com/data/connex/redshift.md): Configuring your Redshift destination.
- [Databricks](https://docs.thanx.com/data/connex/databricks.md): Configuring your Databricks destination.
- [Athena](https://docs.thanx.com/data/connex/athena.md): Configuring your AWS Athena destination.
- [ClickHouse](https://docs.thanx.com/data/connex/click-house.md): Configuring your ClickHouse destination.
- [Generic Postgres](https://docs.thanx.com/data/connex/postgres.md): Configuring your generic Postgres destination.
- [AWS RDS & Aurora Postgres](https://docs.thanx.com/data/connex/aws-postgres.md): Configuring your AWS Postgres (RDS or Aurora) destination.
- [Generic MySQL](https://docs.thanx.com/data/connex/mysql.md): Configuring your generic MySQL destination.
- [AWS RDS & Aurora MySQL](https://docs.thanx.com/data/connex/aws-mysql.md)
- [SQL Server](https://docs.thanx.com/data/connex/sql-server.md): Configuring your SQL Server destination.
- [S3](https://docs.thanx.com/data/connex/s3.md): Configuring your AWS S3 destination.
- [S3 Compatible](https://docs.thanx.com/data/connex/s3-compatible.md): Configuring your S3 compatible destination.
- [Google Cloud Storage](https://docs.thanx.com/data/connex/google-cloud-storage.md): Configuring your Google Cloud Storage destination.
- [Azure Blob Storage](https://docs.thanx.com/data/connex/azure-blob-storage.md): Configuring your Azure Blob Storage destination.
- [Google Sheets](https://docs.thanx.com/data/connex/google-sheets.md): Configuring your Google Sheets destination.
- [Campaigns](https://docs.thanx.com/data/models/campaigns.md)
- [Communication Preferences](https://docs.thanx.com/data/models/communication-preferences.md)
- [Memberships](https://docs.thanx.com/data/models/memberships.md)
- [NPS Feedback](https://docs.thanx.com/data/models/nps-feedback.md)
- [Points Accounts](https://docs.thanx.com/data/models/points-accounts.md)
- [Points Transactions](https://docs.thanx.com/data/models/points-transactions.md)
- [Programs](https://docs.thanx.com/data/models/programs.md)
- [Purchases](https://docs.thanx.com/data/models/purchases.md)
- [Rewards](https://docs.thanx.com/data/models/rewards.md)
- [Loyalty Reward Progress (Legacy)](https://docs.thanx.com/data/models/loyalty-reward-progress-legacy.md)
- [AI Integration](https://docs.thanx.com/ai/overview.md)
- [Docs MCP Server](https://docs.thanx.com/ai/docs-mcp.md): Set up the Thanx documentation MCP server for AI-powered search and interaction

## OpenAPI Specs

- [package](https://docs.thanx.com/package.json)
- [config](https://docs.thanx.com/.circleci/config.yml)

## Optional

- [Help Center](https://help.thanx.com/hc/en-us)
- [Thanx Product Updates](https://thanx.launchnotes.io/)
- [Status](https://status.thanx.com)
- [Email Support](mailto:developer.support@thanx.com)