Update badge (by id)

JavaScript

import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

const badge = await client.loyalty.badges.update('123e4567-e89b-12d3-a456-426614174333');

console.log(badge.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174333",
  "name": "Example Badge",
  "description": "Example description",
  "imageUrl": "https://example.com/image.png",
  "loyaltyConditions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "type": "rule",
      "description": "Example description",
      "amount": 10,
      "repeatCount": 5,
      "requiredCount": 5,
      "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174333",
      "association": [
        {
          "loyaltyRule": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyBadge": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyRuleGroup": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyCurrency": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyLeaderboardView": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        }
      ],
      "loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "csvUrl": "https://example.com/csv",
      "csvFiles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "url": "https://example.com/file.csv",
          "name": "file.csv",
          "description": "Example description"
        }
      ]
    }
  ],
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "hideInUi": false,
  "loyaltyBadgeUsers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "userId": "123e4567-e89b-12d3-a456-426614174222",
      "websiteId": "123e4567-e89b-12d3-a456-426614174111",
      "organizationId": "123e4567-e89b-12d3-a456-426614174222",
      "status": "active",
      "loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174333",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "hideInUi": false,
      "progress": "<unknown>",
      "dismissedInUi": false,
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174222",
        "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
      }
    }
  ],
  "loyaltyRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "name": "Example Rule"
    }
  ],
  "dataJobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "status": "pending",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "message": "Data job is pending"
    }
  ]
}

POST

api

loyalty

badges

{id}

JavaScript

import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

const badge = await client.loyalty.badges.update('123e4567-e89b-12d3-a456-426614174333');

console.log(badge.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174333",
  "name": "Example Badge",
  "description": "Example description",
  "imageUrl": "https://example.com/image.png",
  "loyaltyConditions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "type": "rule",
      "description": "Example description",
      "amount": 10,
      "repeatCount": 5,
      "requiredCount": 5,
      "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174333",
      "association": [
        {
          "loyaltyRule": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyBadge": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyRuleGroup": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyCurrency": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          },
          "loyaltyLeaderboardView": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        }
      ],
      "loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "csvUrl": "https://example.com/csv",
      "csvFiles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "url": "https://example.com/file.csv",
          "name": "file.csv",
          "description": "Example description"
        }
      ]
    }
  ],
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "hideInUi": false,
  "loyaltyBadgeUsers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "userId": "123e4567-e89b-12d3-a456-426614174222",
      "websiteId": "123e4567-e89b-12d3-a456-426614174111",
      "organizationId": "123e4567-e89b-12d3-a456-426614174222",
      "status": "active",
      "loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174333",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "hideInUi": false,
      "progress": "<unknown>",
      "dismissedInUi": false,
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174222",
        "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
      }
    }
  ],
  "loyaltyRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "name": "Example Rule"
    }
  ],
  "dataJobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "status": "pending",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "message": "Data job is pending"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string<uuid>

required

UUID of the badge to update (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

Body

application/json

Body

Schema for updating an existing badge.

name

string

The name of the badge

Example:

"Example Badge"

description

string

The description of the badge

Example:

"Example description"

imageUrl

string<uri>

The URL of the badge image

Example:

"https://example.com/image.png"

hideInUi

boolean

default:false

Whether to hide this badge in the user interface

Example:

false

csvFiles

object[]

Show child attributes

csvFiles.src

string<uri>

required

csvFiles.name

string

Maximum string length: 250

csvFiles.description

string

Maximum string length: 250

Response

200

Response returned upon successful update of the badge.

string<uuid>

required

UUID of the badge (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

name

string

required

The name of the badge

Example:

"Example Badge"

description

string | null

required

The description of the badge

Example:

"Example description"

imageUrl

string<uri> | null

required

The URL of the badge image

Example:

"https://example.com/image.png"

loyaltyConditions

Loyalty Condition Schema · object[]

required

Array of conditions of the badge

Show child attributes

loyaltyConditions.id

string<uuid>

required

UUID of the condition (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyConditions.type

enum<string>

required

The type of the condition

Available options:

rule,

rules,

points,

section,

level,

api,

badge,

badges,

csv

Example:

"rule"

loyaltyConditions.description

string | null

required

The description of the condition

Example:

"Example description"

loyaltyConditions.amount

number | null

required

The amount of the condition

Example:

10

loyaltyConditions.repeatCount

number | null

required

The repeat count of the condition

Example:

5

loyaltyConditions.requiredCount

number | null

required

The required count of the condition

Example:

5

loyaltyConditions.loyaltyRuleGroupId

string<uuid> | null

required

UUID of the rule group (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyConditions.association

object[]

required

Show child attributes

loyaltyConditions.association.loyaltyRule

object

required

Show child attributes

loyaltyConditions.association.loyaltyRule.id

string<uuid>

required

UUID of the association (converted to lowercase)

loyaltyConditions.association.loyaltyRule.name

string

required

The name of the association

loyaltyConditions.association.loyaltyBadge

object

required

Show child attributes

loyaltyConditions.association.loyaltyBadge.id

string<uuid>

required

UUID of the association (converted to lowercase)

loyaltyConditions.association.loyaltyBadge.name

string

required

The name of the association

loyaltyConditions.association.loyaltyRuleGroup

object

required

Show child attributes

loyaltyConditions.association.loyaltyRuleGroup.id

string<uuid>

required

UUID of the association (converted to lowercase)

loyaltyConditions.association.loyaltyRuleGroup.name

string

required

The name of the association

loyaltyConditions.association.loyaltyCurrency

object

required

Show child attributes

loyaltyConditions.association.loyaltyCurrency.id

string<uuid>

required

UUID of the association (converted to lowercase)

loyaltyConditions.association.loyaltyCurrency.name

string

required

The name of the association

loyaltyConditions.association.loyaltyLeaderboardView

object

required

Show child attributes

loyaltyConditions.association.loyaltyLeaderboardView.id

string<uuid>

required

UUID of the association (converted to lowercase)

loyaltyConditions.association.loyaltyLeaderboardView.name

string

required

The name of the association

loyaltyConditions.loyaltyCurrencyId

string<uuid> | null

required

UUID of the currency (converted to lowercase)

loyaltyConditions.csvUrl

string<uri> | null

required

URL of the CSV file

Example:

"https://example.com/csv"

loyaltyConditions.csvFiles

CSV Files · object[]

Array of CSV files associated with the condition

Show child attributes

loyaltyConditions.csvFiles.id

string<uuid>

required

UUID of the CSV file (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyConditions.csvFiles.url

string<uri> | null

required

The URL of the CSV file

Example:

"https://example.com/file.csv"

loyaltyConditions.csvFiles.name

string | null

required

The name of the CSV file

Example:

"file.csv"

loyaltyConditions.csvFiles.description

string | null

required

The description of the CSV file

Example:

"Example description"

createdAt

string<date-time>

required

The date and time the badge was created

Example:

"2021-01-01T00:00:00.000Z"

updatedAt

string<date-time>

required

The date and time the badge was updated

Example:

"2021-01-01T00:00:00.000Z"

hideInUi

boolean

default:false

Whether to hide this badge in the user interface

Example:

false

loyaltyBadgeUsers

User Badges · object[]

Array of user badges

Show child attributes

loyaltyBadgeUsers.id

string<uuid>

required

UUID of the user badge (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyBadgeUsers.userId

string<uuid>

required

UUID of the user (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174222"

loyaltyBadgeUsers.websiteId

string<uuid>

required

UUID of the website (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174111"

loyaltyBadgeUsers.organizationId

string<uuid>

required

UUID of the organization (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174222"

loyaltyBadgeUsers.status

enum<string>

required

The status of the badge

Available options:

active,

inactive,

revoked

Example:

"active"

loyaltyBadgeUsers.loyaltyBadgeId

string<uuid>

required

UUID of the badge (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyBadgeUsers.createdAt

string<date-time>

required

The date and time the user badge was created

Example:

"2021-01-01T00:00:00.000Z"

loyaltyBadgeUsers.updatedAt

string<date-time>

required

The date and time the user badge was updated

Example:

"2021-01-01T00:00:00.000Z"

loyaltyBadgeUsers.hideInUi

boolean

default:false

Whether to hide this badge in the user interface

Example:

false

loyaltyBadgeUsers.progress

any | null

Array of progress for the badge

loyaltyBadgeUsers.dismissedInUi

boolean

Whether the user has dismissed the badge in the UI

Example:

false

loyaltyBadgeUsers.user

User · object

User associated with the user badge

Show child attributes

loyaltyBadgeUsers.user.id

string<uuid>

required

UUID of the user (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174222"

loyaltyBadgeUsers.user.walletAddress

string

required

Wallet address of the user

Example:

"0x1234567890abcdef1234567890abcdef12345678"

loyaltyRules

Loyalty Rules · object[]

Array of loyalty rules associated with the badge

Show child attributes

loyaltyRules.id

string<uuid>

required

UUID of the loyalty rule (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyRules.name

string

required

The name of the loyalty rule

Example:

"Example Rule"

dataJobs

Data Jobs · object[]

Array of data jobs associated with the badge

Show child attributes

dataJobs.id

string<uuid>

required

UUID of the data job (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

dataJobs.status

enum<string>

required

The status of the data job

Available options:

pending,

processing,

complete,

failed,

cancelled

Example:

"pending"

dataJobs.createdAt

string<date-time>

required

The date and time the data job was created

Example:

"2021-01-01T00:00:00.000Z"

dataJobs.updatedAt

string<date-time>

required

The date and time the data job was updated

Example:

"2021-01-01T00:00:00.000Z"

dataJobs.message

string | null

The message associated with the data job

Example:

"Data job is pending"

Create new badge Delete badge (by id)

⌘I

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Social Posts

Minting

Question

Referrals

Website

Landing Page

Token Claims

Update badge (by id)

Authorizations

Path Parameters

Body

Response