POST
/
api
/
loyalty
/
rule_statuses
import SnagSolutions from '@snagsolutions/sdk';

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

async function main() {
  const ruleStatus = await client.loyalty.transactions.ruleStatuses.update({
    loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174030',
  });

  console.log(ruleStatus.id);
}

main();
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loyaltyRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "progress": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
Body
loyaltyRuleId
string
required

Unique identifier for the loyalty rule

Example:

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

organizationId
string

Unique identifier for the organization

Example:

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

websiteId
string

Unique identifier for the website

Example:

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

userId
string

Unique identifier for the user, either userId or walletAddress must be provided

Example:

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

walletAddress
string

Unique identifier for the wallet address, either userId or walletAddress must be provided

Example:

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

progress
number

Progress of the loyalty rule

Required range: 0 <= x <= 100
Example:

50

incProgress
number

Increment progress of the loyalty rule

Required range: 0 <= x <= 100
Example:

10

Response

200
application/json
200
id
string
required
websiteId
string
required
organizationId
string
required
userId
string
required
loyaltyRuleId
string
required
progress
number
required
createdAt
string
required
updatedAt
string
required