Skip to main content
POST
/
api
/
loyalty
/
badges
Create new badge
curl --request POST \
  --url https://admin.snagsolutions.io/api/loyalty/badges \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "organizationId": "123e4567-e89b-12d3-a456-426614174222",
  "websiteId": "123e4567-e89b-12d3-a456-426614174111",
  "name": "Example Badge",
  "imageUrl": "https://example.com/image.png",
  "conditions": [
    {
      "type": "rule",
      "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111"
    }
  ],
  "hideInUi": false,
  "description": "Example description",
  "rewards": [
    {
      "rewardType": "points",
      "loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174333",
      "loyaltyCurrencyIds": [
        "123e4567-e89b-12d3-a456-426614174333"
      ],
      "amount": 100,
      "multiplier": 2.5,
      "isRetroactive": false
    }
  ],
  "csvFiles": [
    {
      "src": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ]
}
'
{
  "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,
  "rewards": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "rewardType": "points",
      "loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174333",
      "amount": 100,
      "multiplier": 2.5,
      "isRetroactive": false,
      "loyaltyCurrencyIds": [
        "123e4567-e89b-12d3-a456-426614174333"
      ]
    }
  ],
  "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"
      },
      "completedAt": "2021-01-01T00:00:00.000Z"
    }
  ],
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.snagsolutions.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Body

Schema for creating a new badge.

​
organizationId
string<uuid>
required

UUID of the organization (optional, converted to lowercase)

Example:

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

​
websiteId
string<uuid>
required

UUID of the website (optional, converted to lowercase)

Example:

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

​
name
string
required

The name of the badge

Example:

"Example Badge"

​
imageUrl
string<uri>
required

The URL of the badge image

Example:

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

​
conditions
Conditions · object[]
required

Array of conditions for the badge

Example:
[
  {
    "type": "rule",
    "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111"
  }
]
​
hideInUi
boolean
default:false

Whether to hide this badge in the user interface

Example:

false

​
description
string

The description of the badge

Example:

"Example description"

​
rewards
Rewards · object[]

Array of rewards granted when the badge is achieved

​
csvFiles
object[]

Response

200

Response returned upon successful creation of the badge.

​
id
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

​
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

​
rewards
Rewards · object[]

Array of rewards granted when the badge is achieved

​
loyaltyBadgeUsers
User Badges · object[]

Array of user badges

​
loyaltyRules
Loyalty Rules · object[]

Array of loyalty rules associated with the badge

​
dataJobs
Data Jobs · object[]

Array of data jobs associated with the badge