Skip to main content
POST
/
api
/
loyalty
/
badges
/
{id}
/
revoke
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 response = await client.loyalty.badges.revoke('123e4567-e89b-12d3-a456-426614174333');

console.log(response.data);
{
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "loyaltyBadgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "active"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string<uuid>
required

UUID of the badge (converted to lowercase)

Example:

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

Body

application/json

Body

Schema for a update user badge schema

​
userId
string<uuid>

UUID of the user (converted to lowercase)

Example:

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

​
walletAddress
string

Validated and formatted wallet address

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
status
enum<string>

Status of the badge

Available options:
active,
inactive,
revoked
Example:

"revoked"

Response

200

Response returned upon successful update of the user badge

​
message
string
required

The message returned upon update of the badge

​
data
object
required