Api changelog

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/auction_bids

Parameters:

The bid ID(s) - accepts a single ID or an array of IDs

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):

    Schema for a get auction bids response

    New required properties:
    • auction
    • Added property auction (object)
      • Property id (string)
      • Property name (string)

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/loyalty/rules

Parameters:

Whether to include deleted/archived records

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

POST /api/loyalty/rules//complete

Request:

• Added property skipChainOrRequiredCheck (boolean)

  Flag indicating if the chain or required check should be skipped.

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/minting/status/

Parameters:

POST /api/minting/status/

Parameters:

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

POST /api/minting/contracts/mint

Return Type:

202

200

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s New

GET /api/minting/status/

Get mint status

POST /api/minting/status/

Update mint status

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

POST /api/users/metadatas

Request:

• Added property githubUser (string)
• Added property githubUserId (string)

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property type (string) Added enum values:
          • connected_github
          • github_repo_star
        • Changed property metadata (object)
          • Added property githubRepoUrl (string)

            URL of the GitHub repository to check for star.

          • Changed property socialPlatform (string)

            Social media platform associated with the rule.

            Added enum value:
            • GitHub

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property type (string)

  Type of loyalty rule being created

  Added enum values:
  • connected_github
  • github_repo_star
• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Added property githubRepoUrl (string)

    URL of the GitHub repository to check for star.

  • Changed property socialPlatform (string)

    Social media platform associated with the rule.

    Added enum value:
    • GitHub

Return Type:

200

• Changed content type : application/json
  • Changed property type (string)

    Type of loyalty rule being created

    Added enum values:
    • connected_github
    • github_repo_star
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Added property githubRepoUrl (string)

      URL of the GitHub repository to check for star.

    • Changed property socialPlatform (string)

      Social media platform associated with the rule.

      Added enum value:
      • GitHub

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Added property githubRepoUrl (string)

    URL of the GitHub repository to check for star.

  • Changed property socialPlatform (string)

    Social media platform associated with the rule.

    Added enum value:
    • GitHub

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Added property githubRepoUrl (string)

      URL of the GitHub repository to check for star.

    • Changed property socialPlatform (string)

      Social media platform associated with the rule.

      Added enum value:
      • GitHub

POST /api/minting/contracts/mint

Request:

• Changed property shippingOrderType (string) Added enum value:
  • github

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/auction_bids

Parameters:

Order bids by amount (ascending or descending). Defaults to desc.

Number of bids to skip (for offset-based pagination)

Include total count of matching bids in response

Filter by multiple bid statuses (OR condition)

Return Type:

200

• Changed content type : application/json
  • Added property count (number)

    Total count of matching bids (only present when includeCount=true)

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/auction_bids

Parameters:

The bid ID

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get auction bids response New optional properties:
    • auction
    • Deleted property auction (object)

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/auction_bids

Parameters:

The bid ID(s) - accepts a single ID or an array of IDs

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get auction bids response New required properties:
    • auction
    • Added property auction (object)
      • Property id (string)
      • Property name (string)

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property metadata (object)
          • Changed property liquidity (object)

            Liquidity pool details.

            • Changed property network (string)

              Blockchain network of the liquidity pool.

              Added enum value:
              • zkverify
          • Changed property collection (array)

            Array of collections associated with the rule.

            Changed items (object):
            • Changed property network (string)

              Blockchain network of the collection.

              Added enum value:
              • zkverify

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum value:
  • zkverify
• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum value:
      • zkverify
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum value:
      • zkverify
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum value:
    • zkverify

Return Type:

200

• Changed content type : application/json
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum value:
    • zkverify
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum value:
        • zkverify
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum value:
        • zkverify
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum value:
      • zkverify

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum value:
      • zkverify
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum value:
      • zkverify
• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum value:
  • zkverify
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum value:
    • zkverify

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum value:
        • zkverify
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum value:
        • zkverify
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum value:
    • zkverify
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum value:
      • zkverify

GET /api/minting/assets

Parameters:

Network

POST /api/website_collections

Request:

• Changed property network (string) Added enum value:
  • zkverify

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property metadata (object)
          • Changed property liquidity (object)

            Liquidity pool details.

            • Changed property network (string)

              Blockchain network of the liquidity pool.

              Added enum value:
              • zkverify
          • Changed property collection (array)

            Array of collections associated with the rule.

            Changed items (object):
            • Changed property network (string)

              Blockchain network of the collection.

              Added enum value:
              • zkverify

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum value:
  • zkverify
• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum value:
      • zkverify
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum value:
      • zkverify
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum value:
    • zkverify

Return Type:

200

• Changed content type : application/json
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum value:
    • zkverify
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum value:
        • zkverify
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum value:
        • zkverify
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum value:
      • zkverify

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum value:
      • zkverify
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum value:
      • zkverify
• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum value:
  • zkverify
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum value:
    • zkverify

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum value:
        • zkverify
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum value:
        • zkverify
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum value:
    • zkverify
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum value:
      • zkverify

GET /api/minting/assets

Parameters:

Network

POST /api/website_collections

Request:

• Changed property network (string) Added enum value:
  • zkverify

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property metadata (object)
          • Changed property liquidity (object)

            Liquidity pool details.

            • Changed property network (string)

              Blockchain network of the liquidity pool.

              Added enum values:
              • polkadot
              • kusama
          • Changed property collection (array)

            Array of collections associated with the rule.

            Changed items (object):
            • Changed property network (string)

              Blockchain network of the collection.

              Added enum values:
              • polkadot
              • kusama

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum values:
  • polkadot
  • kusama
• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum values:
      • polkadot
      • kusama
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum values:
      • polkadot
      • kusama
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum values:
    • polkadot
    • kusama

Return Type:

200

• Changed content type : application/json
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum values:
    • polkadot
    • kusama
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum values:
        • polkadot
        • kusama
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum values:
        • polkadot
        • kusama
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum values:
      • polkadot
      • kusama

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property liquidity (object)

    Liquidity pool details.

    • Changed property network (string)

      Blockchain network of the liquidity pool.

      Added enum values:
      • polkadot
      • kusama
  • Changed property collection (array)

    Array of collections associated with the rule.

    Changed items (object):
    • Changed property network (string)

      Blockchain network of the collection.

      Added enum values:
      • polkadot
      • kusama
• Changed property network (string)

  Blockchain network where the rule will apply

  Added enum values:
  • polkadot
  • kusama
• Changed property collections (array)

  List of associated collections

  Changed items (object):
  • Changed property network (string)

    Blockchain network for the collection

    Added enum values:
    • polkadot
    • kusama

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property liquidity (object)

      Liquidity pool details.

      • Changed property network (string)

        Blockchain network of the liquidity pool.

        Added enum values:
        • polkadot
        • kusama
    • Changed property collection (array)

      Array of collections associated with the rule.

      Changed items (object):
      • Changed property network (string)

        Blockchain network of the collection.

        Added enum values:
        • polkadot
        • kusama
  • Changed property network (string)

    Blockchain network where the rule will apply

    Added enum values:
    • polkadot
    • kusama
  • Changed property collections (array)

    List of associated collections

    Changed items (object):
    • Changed property network (string)

      Blockchain network for the collection

      Added enum values:
      • polkadot
      • kusama

GET /api/minting/assets

Parameters:

Network

POST /api/website_collections

Request:

• Changed property network (string) Added enum values:
  • polkadot
  • kusama

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

POST /api/users/connect

Request:

• Changed property walletType (string) Added enum value:
  • substrate

GET /api/loyalty/badges

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Response returned upon successful fetching of the badges.
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

    • Changed property loyaltyBadgeUsers (array)

      Array of user badges

      Changed items (object):
      • Added property hideInUi (boolean)

        Whether to hide this badge in the user interface

POST /api/loyalty/badges

Request:

• Added property hideInUi (boolean)

  Whether to hide this badge in the user interface

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

POST /api/loyalty/badges/

Request:

• Added property hideInUi (boolean)

  Whether to hide this badge in the user interface

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

DELETE /api/loyalty/badges/

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property metadata (object)
          • Changed property walletType (string)

            Type of wallet associated with the rule.

            Added enum value:
            • substrate

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property walletType (string)

    Type of wallet associated with the rule.

    Added enum value:
    • substrate

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property walletType (string)

      Type of wallet associated with the rule.

      Added enum value:
      • substrate

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property walletType (string)

    Type of wallet associated with the rule.

    Added enum value:
    • substrate

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property walletType (string)

      Type of wallet associated with the rule.

      Added enum value:
      • substrate

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

POST /api/users/connect

Request:

• Changed property walletType (string) Added enum value:
  • substrate

GET /api/loyalty/rule_edits

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property data (object)

      Data that was changed on the rule

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

    • Changed property previousData (object)

      Previous data of the rule before the edit

      • Changed property metadata (object)

        Optional metadata for the loyalty rule

POST /api/loyalty/rule_edits//restore

Return Type:

200

• Changed content type : application/json
  • Changed property data (object)

    Data that was changed on the rule

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

  • Changed property previousData (object)

    Previous data of the rule before the edit

    • Changed property metadata (object)

      Optional metadata for the loyalty rule

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property metadata (object)
          • Changed property walletType (string)

            Type of wallet associated with the rule.

            Added enum value:
            • substrate

GET /api/loyalty/rules

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object):
    • Changed property metadata (object)

      Optional metadata for the loyalty rule

POST /api/loyalty/rules

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property walletType (string)

    Type of wallet associated with the rule.

    Added enum value:
    • substrate

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property walletType (string)

      Type of wallet associated with the rule.

      Added enum value:
      • substrate

POST /api/loyalty/rules/

Request:

• Changed property metadata (object)

  Additional metadata for the loyalty rule

  • Changed property walletType (string)

    Type of wallet associated with the rule.

    Added enum value:
    • substrate

Return Type:

200

• Changed content type : application/json
  • Changed property metadata (object)

    Additional metadata for the loyalty rule

    • Changed property walletType (string)

      Type of wallet associated with the rule.

      Added enum value:
      • substrate

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s Changed

GET /api/loyalty/badges

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Response returned upon successful fetching of the badges.
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

    • Changed property loyaltyBadgeUsers (array)

      Array of user badges

      Changed items (object):
      • Added property hideInUi (boolean)

        Whether to hide this badge in the user interface

POST /api/loyalty/badges

Request:

• Added property hideInUi (boolean)

  Whether to hide this badge in the user interface

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

POST /api/loyalty/badges/

Request:

• Added property hideInUi (boolean)

  Whether to hide this badge in the user interface

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

DELETE /api/loyalty/badges/

Return Type:

200

• Changed content type : application/json
  • Added property hideInUi (boolean)

    Whether to hide this badge in the user interface

  • Changed property loyaltyBadgeUsers (array)

    Array of user badges

    Changed items (object):
    • Added property hideInUi (boolean)

      Whether to hide this badge in the user interface

​

Result

​

Snag Solutions - API Docs (v 0.1)

​

What’s New

POST /api/minting/contracts/mint

Mint an asset

​

What’s Deleted

POST /api/minting/contracts/generate_signature

Mint an asset

​

Result

​

What’s Changed

POST /api/website_user_roles

Request:

• Changed property websiteUserRoles (array)

  Array of website user roles

  Changed items (object):
  • Changed property roleType (string)

    Role type of the user

    Added enum value:
    • WEBSITE_READ_ONLY_API_KEY

​

What’s Changed

GET /api/loyalty/badges

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Response returned upon successful fetching of the badges.
    • Changed property dataJobs (array)

      Array of data jobs associated with the badge

      Changed items (object):
      • Changed property status (string)

        The status of the data job

        Added enum values:
        • processing
        • cancelled

POST /api/loyalty/badges

Return Type:

200

• Changed content type : application/json
  • Changed property dataJobs (array)

    Array of data jobs associated with the badge

    Changed items (object):
    • Changed property status (string)

      The status of the data job

      Added enum values:
      • processing
      • cancelled

POST /api/loyalty/badges/

Return Type:

200

• Changed content type : application/json
  • Changed property dataJobs (array)

    Array of data jobs associated with the badge

    Changed items (object):
    • Changed property status (string)

      The status of the data job

      Added enum values:
      • processing
      • cancelled

DELETE /api/loyalty/badges/

Return Type:

200

• Changed content type : application/json
  • Changed property dataJobs (array)

    Array of data jobs associated with the badge

    Changed items (object):
    • Changed property status (string)

      The status of the data job

      Added enum values:
      • processing
      • cancelled

​

What’s Changed

GET /api/users

Return Type:

200

• Changed content type : application/json
  • Changed property data (array)

    Schema for users response

    Changed items (object): > Schema for a user response
    • Changed property referrers (array) Changed items (object): New required properties:
      • referralCode
      • Added property referralCode (object)
        • Property user (object)

          Use who referred the user

          • Property id (string)
          • Property walletAddress (string)

​

What’s Changed

POST /api/minting/contracts/generate_signature

Request:

• Deleted property createOnly (boolean)

Return Type:

200

• Changed content type : application/json
  • Added property latest (object)

    Only for Solana

    • Property blockhash (string)
    • Property lastValidBlockHeight (number)

​

What’s Changed

GET /api/referral/users

Parameters:

​

What’s Changed

POST /api/token_claims//claim

Request:

• txHash

• Added property txHash (string)

​

What’s Changed

GET /api/auction_bids

Return Type:

200

• New content type : application/json

GET /api/users

Return Type:

200

• Changed content type : application/json New required properties:
  • hasNextPage
  • Added property hasNextPage (boolean)

    Indicates if there is a next page of results

GET /api/website_user_attributes

Parameters:

Pagination cursor to start after a specific resource ID

Maximum number of records to return (max 100)

GET /api/website_user_attributes/values

Parameters:

Pagination cursor to start after a specific resource ID

Maximum number of records to return (max 100)

GET /api/loyalty/badges

Return Type:

200

• Changed content type : application/json New required properties:
  • data
  • hasNextPage
  New optional properties:
  • createdAt
  • description
  • id
  • imageUrl
  • loyaltyConditions
  • name
  • updatedAt
  • Added property data (array) Items (object): > Response returned upon successful fetching of the badges.
    • Property id (string)

      UUID of the badge (converted to lowercase)

    • Property name (string)

      The name of the badge

    • Property description (string)

      The description of the badge

    • Property imageUrl (string)

      The URL of the badge image

    • Property loyaltyConditions (array)

      Array of conditions of the badge

      Items (object): > Schema for a loyalty condition rule.
      • Property id (string)

        UUID of the condition (converted to lowercase)

      • Property type (string)

        The type of the condition

        Enum values:
        • rule
        • rules
        • points
        • section
        • level
        • api
        • badge
        • badges
        • csv
      • Property description (string)

        The description of the condition

      • Property amount (number)

        The amount of the condition

      • Property repeatCount (number)

        The repeat count of the condition

      • Property requiredCount (number)

        The required count of the condition

      • Property loyaltyRuleGroupId (string)

        UUID of the rule group (converted to lowercase)

      • Property association (array) Items (object):
        • Property loyaltyRule (object)
          • Property id (string)

            UUID of the association (converted to lowercase)

          • Property name (string)

            The name of the association

        • Property loyaltyBadge (object)
        • Property loyaltyRuleGroup (object)
        • Property loyaltyCurrency (object)
        • Property loyaltyLeaderboardView (object)
      • Property loyaltyCurrencyId (string)

        UUID of the currency (converted to lowercase)

      • Property csvUrl (string)

        URL of the CSV file

      • Property csvFiles (array)

        Array of CSV files associated with the condition

        Items (object):
        • Property id (string)

          UUID of the CSV file (converted to lowercase)

        • Property url (string)

          The URL of the CSV file

        • Property name (string)

          The name of the CSV file

        • Property description (string)

          The description of the CSV file

    • Property loyaltyBadgeUsers (array)

      Array of user badges

      Items (object):
      • Property id (string)

        UUID of the user badge (converted to lowercase)

      • Property userId (string)

        UUID of the user (converted to lowercase)

      • Property websiteId (string)

        UUID of the website (converted to lowercase)

      • Property organizationId (string)

        UUID of the organization (converted to lowercase)

      • Property status (string)

        The status of the badge

        Enum values:
        • active
        • inactive
        • revoked
      • Property loyaltyBadgeId (string)

        UUID of the badge (converted to lowercase)

      • Property progress (object)

        Array of progress for the badge

      • Property dismissedInUi (boolean)

        Whether the user has dismissed the badge in the UI

      • Property user (object)

        User associated with the user badge

        • Property id (string)

          UUID of the user (converted to lowercase)

        • Property walletAddress (string)

          Wallet address of the user

      • Property createdAt (string)

        The date and time the user badge was created

      • Property updatedAt (string)

        The date and time the user badge was updated

    • Property loyaltyRules (array)

      Array of loyalty rules associated with the badge

      Items (object):
      • Property id (string)

        UUID of the loyalty rule (converted to lowercase)

      • Property name (string)

        The name of the loyalty rule

    • Property dataJobs (array)

      Array of data jobs associated with the badge

      Items (object):
      • Property id (string)

        UUID of the data job (converted to lowercase)

      • Property status (string)

        The status of the data job

        Enum values:
        • pending
        • complete
        • failed
      • Property message (string)

        The message associated with the data job

      • Property createdAt (string)

        The date and time the data job was created

      • Property updatedAt (string)

        The date and time the data job was updated

    • Property createdAt (string)

      The date and time the badge was created

    • Property updatedAt (string)

      The date and time the badge was updated

  • Added property hasNextPage (boolean)

    Indicates if there is a next page of results

  • Deleted property id (string)

    UUID of the badge (converted to lowercase)

  • Deleted property name (string)

    The name of the badge

  • Deleted property description (string)

    The description of the badge

  • Deleted property imageUrl (string)

    The URL of the badge image

  • Deleted property loyaltyConditions (array)

    Array of conditions of the badge

  • Deleted property loyaltyBadgeUsers (array)

    Array of user badges

  • Deleted property loyaltyRules (array)

    Array of loyalty rules associated with the badge

  • Deleted property dataJobs (array)

    Array of data jobs associated with the badge

  • Deleted property createdAt (string)

    The date and time the badge was created

  • Deleted property updatedAt (string)

    The date and time the badge was updated

GET /api/loyalty/questions

Parameters:

Maximum number of records to return (max 100)

Pagination cursor to start after a specific resource ID

Return Type:

200

• Changed content type : application/json

GET /api/loyalty/questions_responses

Parameters:

Maximum number of records to return (max 100)

Pagination cursor to start after a specific resource ID

Return Type:

200

• Changed content type : application/json New required properties:
  • data
  • hasNextPage
  New optional properties:
  • responses
  • Added property data (array) Items (object): > Response details including the question and choice information
    • Property id (string)
    • Property userId (string)
    • Property loyaltyQuestionId (string)
    • Property loyaltyQuestionChoiceId (string)
    • Property createdAt (string)
    • Property isCorrect (boolean)
    • Property question (object)
      • Property text (string)
      • Property loyaltyQuestionChoices (array) Items (object):
        • Property id (string)
        • Property text (string)
        • Property isCorrect (boolean)
  • Added property hasNextPage (boolean)

    Indicates if there are more pages of results available

  • Deleted property responses (array)

​

What’s Changed

GET /api/token_claims

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): New required properties:
    • stakingContractAddress
    • Added property claimAndStake (boolean)
    • Added property stakingContractType (string) Enum values:
      • linear
      • timelock
    • Added property stakingContractAddress (string)
    • Added property maxBonus (number)
    • Added property minLockup (number)
    • Added property minLockupForMultiplier (number)
    • Added property multiplier (number)
    • Added property isStakingOptional (boolean)
    • Changed property csvUrl (string)

GET /api/token_claims//eligibility

Return Type:

200

• Changed content type : application/json New required properties:
  • stakes
  • Added property stakes (array) Items (object):
    • Property stakeId (string)
    • Property amount (string)
    • Property duration (number)
    • Property startTime (string)
    • Property claimed (string)
    • Property claimable (string)

​

What’s Changed

GET /api/token_claims

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): New required properties:
    • stakingContractAddress
    • Added property claimAndStake (boolean)
    • Added property stakingContractType (string) Enum values:
      • linear
      • timelock
    • Added property stakingContractAddress (string)
    • Added property maxBonus (number)
    • Added property minLockup (number)
    • Added property minLockupForMultiplier (number)
    • Added property multiplier (number)
    • Added property isStakingOptional (boolean)
    • Changed property csvUrl (string)

GET /api/token_claims//eligibility

Return Type:

200

• Changed content type : application/json New required properties:
  • stakes
  • Added property stakes (array) Items (object):
    • Property stakeId (string)
    • Property amount (string)
    • Property duration (number)
    • Property startTime (string)
    • Property claimed (string)
    • Property claimable (string)

​

What’s Changed

GET /api/loyalty/posts

​

What’s Changed

GET /api/loyalty/rule_groups

Return Type:

200

• Changed content type : application/json
  • Changed property data (array) Changed items (object): > Schema for a get loyalty rule groups response
    • Changed property loyaltyGroupItems (array) Changed items (object):
      • Changed property loyaltyRule (object)
        • Changed property type (string) Added enum value:
          • tiktok_follow

POST /api/loyalty/rules

Request:

• Changed property type (string)

  Type of loyalty rule being created

  Added enum value:
  • tiktok_follow

Return Type:

200

• Changed content type : application/json
  • Changed property type (string)

    Type of loyalty rule being created

    Added enum value:
    • tiktok_follow

​

What’s Changed

POST /api/users/verify