API Documentation
Identity
- POSTCreate user device
- GETGet user metadata
- POSTCreate user metadata
- GETGet users
- GETUser count
- POSTConnect a user to User Group
- POSTDisconnect a user from User Group
- GETConnect Auth
- POSTPost apiusersverify
- GETGet all website user attributes
- POSTCreate a new website user attribute
- DELDelete a website user attribute
- GETGet all website user attribute values
- POSTCreate a new website user attribute value
Loyalty
- GETGet loyalty accounts
- GETGet the rank of a user based on their loyalty points
- GETGet loyalty account streaks
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet Loyalty Rule Groups
- POSTCreate Loyalty Rule Groups
- POSTUpdate Loyalty Rule Group
- DELDelete Loyalty Rule Group
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- POSTCreate Loyalty Transaction
- GETGet Loyalty Transaction Entries
- GETGet Loyalty Rule Chains
- GETGet Loyalty Rule Statuses
- POSTUpdate Loyalty Rule Status
Badge
Minting
Question
Website
Landing Page
Badge
Create new badge
This endpoint allows you to configure a new badge.
POST
/
api
/
loyalty
/
badges
Copy
Ask AI
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.create({
conditions: [{}],
imageUrl: 'https://example.com/image.png',
name: 'Example Badge',
organizationId: '123e4567-e89b-12d3-a456-426614174222',
websiteId: '123e4567-e89b-12d3-a456-426614174111',
});
console.log(badge.id);
Copy
Ask AI
{
"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/file.csv"
}
],
"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",
"progress": "<any>"
}
],
"loyaltyRules": [
{
"id": "123e4567-e89b-12d3-a456-426614174333"
}
]
}
Authorizations
Body
application/json
Body
Schema for creating a new badge.
Response
200
application/json
200
Response returned upon successful creation of the badge.
Was this page helpful?
Copy
Ask AI
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.create({
conditions: [{}],
imageUrl: 'https://example.com/image.png',
name: 'Example Badge',
organizationId: '123e4567-e89b-12d3-a456-426614174222',
websiteId: '123e4567-e89b-12d3-a456-426614174111',
});
console.log(badge.id);
Copy
Ask AI
{
"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/file.csv"
}
],
"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",
"progress": "<any>"
}
],
"loyaltyRules": [
{
"id": "123e4567-e89b-12d3-a456-426614174333"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.