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
Revoke badge from account
This endpoint allows you to revoke a badge from an account
POST
/
api
/
loyalty
/
badges
/
{id}
/
revoke
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 response = await client.loyalty.badges.revoke('123e4567-e89b-12d3-a456-426614174333');
console.log(response.data);
Copy
Ask AI
{
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"loyaltyBadgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "active"
}
}
Authorizations
Path Parameters
UUID of the badge (converted to lowercase)
Example:
"123e4567-e89b-12d3-a456-426614174333"
Body
application/json
Body
Schema for a update user badge schema
Response
200
application/json
200
Response returned upon successful update of the user 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 response = await client.loyalty.badges.revoke('123e4567-e89b-12d3-a456-426614174333');
console.log(response.data);
Copy
Ask AI
{
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"loyaltyBadgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "active"
}
}
Assistant
Responses are generated using AI and may contain mistakes.