Snag Docs

API Reference

Admin Dashboard

Support

This endpoint allows you to upload a file to the resource. returns a presigned URL and the asset's public URL call put with the file as the body to upload the asst

Get Asset upload URL

Schema for uploading an asset with organization, website, and user details.

Upload Asset Schema

apiKeyAuth

Response returned upon successful generation of the signed URL for uploading the file.

Upload Asset Success Response

Forbidden Response

Welcome

This recipe is a quickstart guide to setting up your Snag Loyalty program, covering the loyalty currency configuration and initial rules set up.

Getting started with loyalty

This recipes explains how to link multiple wallets to allow for aggregate points earning/spending/visiblility.

Multi-wallet accounts

This recipe explains the concept of an external rule, how to configure it with Snag and how to issue rewards to your users.

External loyalty rules

This recipe explains how to leverage the Snag API to fetch loyalty points balances for your users, which can be used to build features like a leaderboard in your application.

Build a points leaderboard

This recipe explains how to create user accounts via the Snag API.

Creating users

This recipe explains how to manually update user loyalty points balances (i.e. not as part of a rule completion or spend action; an example use-case is to reset all user point balances to 0).

Updating Loyalty Balances

Snag API

Snag SDK

This is a list of deprecated APIs with a timeline for removal. We support deprecated APIs for 2 months before permanent removal.

API Deprecation

This endpoint allows you to get users wallet

Get users wallet

This endpoint allows you to create a user wallet

Creates and a user wallet

This endpoint allows you to delete a user wallet

Delete user wallet

This endpoint allows you to create or edit a user metadata

Creates or updates a user metadata

Retrieve configured loyalty rules with optional pagination and filters

Get Loyalty Rules

Create Loyalty Rule

Update Loyalty Rule

Delete Loyalty Rule

Verify a loyalty rule based on user action and reward them if applicable. This endpoint currenlty onlu supports following rule types code_entry, text_input, link_click, discord_member, connect_wallet, check_in, external_rule, drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name, drip_x_text_in_comment, drip_x_tweet, telegram_join

Complete Loyalty Rule

This will return the processing status of quests for a specific user

Get Processing status for a specific user on loyalty rules

Retrieve configured loyalty rule edits with optional pagination and filters

Get Loyalty Rule Edits

Restore Loyalty Rule Edit

Get loyalty accounts

Get loyalty currencies

Create a loyalty currency

Get Loyalty Multipliers

Create a new loyalty multiplier for a wallet.

Create Loyalty Multiplier

Delete a loyalty multiplier by its external identifier.

Delete Loyalty Multiplier by External Identifier

Update Loyalty Multiplier

Delete Loyalty Multiplier by ID

Fetch loyalty transaction entries for wallets or users, representing account balance changes.

Get Loyalty Transaction Entries

This endpoint allows you to fetch badge(s) data.

Get badges (all or by id)

This endpoint allows you to revoke a badge from a specific account.

Revoke badge from account (by id)

Returns a list of auction bids with optional filtering and pagination.

Get auction bids

Create a bid

Completes a specified quest for a user and updates their loyalty account balance if applicable. Run asynchronously; use the verification endpoint to check status.

DEPRECATED (Please use /api/loyalty/rules/{id}/complete instead)

Retrieves the current status of a drip quest verification using the verification ID.

DEPRECATED (Please use /api/loyalty/rules/status instead)

Returns a list of websites. Includes optional query parameters for filtering and pagination.

API Documentation

Assets

Identity

Loyalty

Badges

Auctions

Drip

Websites

Get Asset upload URL

Authorizations

Body

Response