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 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
Loyalty
Create Loyalty Rule Groups
Create a new loyalty rule groups
POST
/
api
/
loyalty
/
rule_groups
/
create
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 response = await client.loyalty.ruleGroups.createRuleGroup({
name: 'name',
organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.id);
}
main();
{
"websiteId": "<string>",
"organizationId": "<string>",
"id": "<string>",
"name": "<string>",
"isRequired": true,
"sortId": 123,
"isCollapsible": true,
"subTitle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Authorizations
Body
application/json
Body
Schema for a create loyalty rule groups body
Response
200
application/json
200
The response is of type object
.
Was this page helpful?
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 response = await client.loyalty.ruleGroups.createRuleGroup({
name: 'name',
organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.id);
}
main();
{
"websiteId": "<string>",
"organizationId": "<string>",
"id": "<string>",
"name": "<string>",
"isRequired": true,
"sortId": 123,
"isCollapsible": true,
"subTitle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Assistant
Responses are generated using AI and may contain mistakes.